Chargebeex.PortalSession (chargebeex v0.6.0)

View Source

Summary

Functions

When an user is sent back to your return URL with session details, you should validate that information by calling this API.

Logs out the portal session. This should be called when customers logout of your application.

Types

t()

@type t() :: %Chargebeex.PortalSession{
  access_url: String.t() | nil,
  created_at: non_neg_integer() | nil,
  customer_id: String.t() | nil,
  expires_at: non_neg_integer() | nil,
  id: String.t() | nil,
  linked_customers: list() | nil,
  object: String.t() | nil,
  redirect_url: String.t() | nil,
  resources: map(),
  status: String.t() | nil,
  token: String.t() | nil
}

Functions

activate(id, params, opts \\ [])

When an user is sent back to your return URL with session details, you should validate that information by calling this API.

build(map_or_kwlist, opts \\ [])

@spec build(ExConstructor.map_or_kwlist(), Keyword.t()) :: %Chargebeex.PortalSession{
  access_url: term(),
  created_at: term(),
  customer_id: term(),
  expires_at: term(),
  id: term(),
  linked_customers: term(),
  object: term(),
  redirect_url: term(),
  resources: term(),
  status: term(),
  token: term()
}

create(params, opts \\ [])

Callback implementation for Chargebeex.Resource.create/2.

logout(id, opts \\ [])

Logs out the portal session. This should be called when customers logout of your application.

retrieve(id, opts \\ [])

Callback implementation for Chargebeex.Resource.retrieve/2.