View Source Chargebeex.PortalSession (chargebeex v0.5.0)

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

@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

Link to this function

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

View Source

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

Link to this function

build(map_or_kwlist, opts \\ [])

View Source
@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()
}
Link to this function

create(params, opts \\ [])

View Source

Callback implementation for Chargebeex.Resource.create/2.

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

Link to this function

retrieve(id, opts \\ [])

View Source

Callback implementation for Chargebeex.Resource.retrieve/2.