exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.Schemas.BillingPortal_session (exoapi_stripe v0.1.4)

description: The Billing customer portal is a Stripe-hosted UI for subscription and billing management.

A portal configuration describes the functionality and features that you want to provide to your customers through the portal.

A portal session describes the instantiation of the customer portal for a particular customer. By visiting the session's URL, the customer can manage their subscriptions and billing details. For security reasons, sessions are short-lived and will expire if the customer does not visit the URL. Create sessions on-demand when customers intend to manage their subscriptions and billing details.

Learn more in the integration guide.

:configuration :: ExOAPI.Stripe.Schemas.BillingPortal_configuration | :string

The configuration used by this session, describing the features available.

:created :: :integer

Time at which the object was created. Measured in seconds since the Unix epoch.

:customer :: ExOAPI.Stripe.Schemas.Customer

The ID of the customer for this session.

:id :: :string

Unique identifier for the object.

:livemode :: :boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

:locale :: :string

The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s preferred_locales or browser’s locale is used.

:object :: :string

String representing the object's type. Objects of the same type share the same value.

:on_behalf_of :: :string

The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this on_behalf_of account appear in the portal. For more information, see the docs. Use the Accounts API to modify the on_behalf_of account's branding settings, which the portal displays.

:return_url :: :string

The URL to redirect customers to when they click on the portal's link to return to your website.

:url :: :string

The short-lived URL of the session that gives customers access to the customer portal.

Link to this section Summary

Types

params()
t()

Functions

changeset(struct \\ %__MODULE__{}, params)

Link to this section Types

Link to this type

params()

View Source 
@type params() :: map()
Link to this type

t()

View Source 
@type t() :: %ExOAPI.Stripe.Schemas.BillingPortal_session{
  configuration: ExOAPI.EctoTypes.AnyOf.t() | nil,
  created: integer() | nil,
  customer: String.t() | nil,
  id: String.t() | nil,
  livemode: boolean() | nil,
  locale:
    (:"zh-TW"
     | :"zh-HK"
     | :zh
     | :vi
     | :tr
     | :th
     | :sv
     | :sl
     | :sk
     | :ru
     | :ro
     | :"pt-BR"
     | :pt
     | :pl
     | :nl
     | :nb
     | :mt
     | :ms
     | :lv
     | :lt
     | :ko
     | :ja
     | :it
     | :id
     | :hu
     | :hr
     | :"fr-CA"
     | :fr
     | :fil
     | :fi
     | :et
     | :"es-419"
     | :es
     | :"en-SG"
     | :"en-NZ"
     | :"en-IN"
     | :"en-IE"
     | :"en-GB"
     | :"en-CA"
     | :"en-AU"
     | :en
     | :el
     | :de
     | :da
     | :cs
     | :bg
     | :auto)
    | nil,
  object: :"billing_portal.session" | nil,
  on_behalf_of: String.t() | nil,
  return_url: String.t() | nil,
  url: String.t() | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source 
@spec changeset(t(), params()) :: Ecto.Changeset.t()