View Source ExOAPI.Stripe.SDK.BillingPortal (exoapi_stripe v0.1.1)

Link to this section Summary

Functions

description: <p>Returns a list of configurations that describe the functionality of the customer portal.</p>

description: <p>Retrieves a configuration that describes the functionality of the customer portal.</p>

description: <p>Creates a configuration that describes the functionality and behavior of a PortalSession</p>

description: <p>Updates a configuration that describes the functionality of the customer portal.</p>

description: <p>Creates a session of the customer portal.</p>

Link to this section Types

Link to this type

get_billing_portal_configurations_configuration_opts()

View Source
@type get_billing_portal_configurations_configuration_opts() :: {:expand, String.t()}
Link to this type

get_billing_portal_configurations_opts()

View Source
@type get_billing_portal_configurations_opts() ::
  {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:is_default, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:active, String.t()}

Link to this section Functions

Link to this function

get_billing_portal_configurations(client, opts \\ [])

View Source
@spec get_billing_portal_configurations(client :: ExOAPI.Client.t(), [
  get_billing_portal_configurations_opts()
]) :: {:ok, any()} | {:error, any()}

description: <p>Returns a list of configurations that describe the functionality of the customer portal.</p>

Link to this function

get_billing_portal_configurations_configuration(client, configuration, opts \\ [])

View Source
@spec get_billing_portal_configurations_configuration(
  client :: ExOAPI.Client.t(),
  configuration :: String.t(),
  [get_billing_portal_configurations_configuration_opts()]
) :: {:ok, any()} | {:error, any()}

description: <p>Retrieves a configuration that describes the functionality of the customer portal.</p>

Link to this function

post_billing_portal_configurations(client, body)

View Source
@spec post_billing_portal_configurations(client :: ExOAPI.Client.t(), body :: map()) ::
  {:ok, any()} | {:error, any()}

description: <p>Creates a configuration that describes the functionality and behavior of a PortalSession</p>

Link to this function

post_billing_portal_configurations_configuration(client, body, configuration)

View Source
@spec post_billing_portal_configurations_configuration(
  client :: ExOAPI.Client.t(),
  body :: map(),
  configuration :: String.t()
) :: {:ok, any()} | {:error, any()}

description: <p>Updates a configuration that describes the functionality of the customer portal.</p>

Link to this function

post_billing_portal_sessions(client, body)

View Source
@spec post_billing_portal_sessions(client :: ExOAPI.Client.t(), body :: map()) ::
  {:ok, any()} | {:error, any()}

description: <p>Creates a session of the customer portal.</p>