@type after_completion() :: %{
  optional(:hosted_confirmation) => hosted_confirmation(),
  optional(:redirect) => redirect(),
  optional(:type) => :hosted_confirmation | :portal_homepage | :redirect
}

Behavior after the flow is completed.

@type coupon_offer() :: %{optional(:coupon) => binary()}

Configuration when retention.type=coupon_offer.

@type flow_data() :: %{
  optional(:after_completion) => after_completion(),
  optional(:subscription_cancel) => subscription_cancel(),
  optional(:subscription_update) => subscription_update(),
  optional(:subscription_update_confirm) => subscription_update_confirm(),
  optional(:type) =>
    :payment_method_update
    | :subscription_cancel
    | :subscription_update
    | :subscription_update_confirm
}

Information about a specific flow for the customer to go through. See the docs to learn more about using customer portal deep links and flows.

@type hosted_confirmation() :: %{optional(:custom_message) => binary()}

Configuration when after_completion.type=hosted_confirmation.

@type redirect() :: %{optional(:return_url) => binary()}

Configuration when after_completion.type=redirect.

@type retention() :: %{
  optional(:coupon_offer) => coupon_offer(),
  optional(:type) => :coupon_offer
}

Specify a retention strategy to be used in the cancellation flow.

@type subscription_cancel() :: %{
  optional(:retention) => retention(),
  optional(:subscription) => binary()
}

Configuration when flow_data.type=subscription_cancel.

@type subscription_update() :: %{optional(:subscription) => binary()}

Configuration when flow_data.type=subscription_update.

@type subscription_update_confirm() :: %{
  optional(:discounts) => [discounts()],
  optional(:items) => [items()],
  optional(:subscription) => binary()
}

Configuration when flow_data.type=subscription_update_confirm.

@type t() :: %Stripe.BillingPortal.Session{
  configuration: binary() | Stripe.BillingPortal.Configuration.t(),
  created: integer(),
  customer: binary(),
  flow: term() | nil,
  id: binary(),
  livemode: boolean(),
  locale: binary() | nil,
  object: binary(),
  on_behalf_of: binary() | nil,
  return_url: binary() | nil,
  url: binary()
}

The billing_portal.session type.

• configuration The configuration used by this session, describing the features available.
• created Time at which the object was created. Measured in seconds since the Unix epoch.
• customer The ID of the customer for this session.
• flow Information about a specific flow for the customer to go through. See the docs to learn more about using customer portal deep links and flows.
• id Unique identifier for the object.
• livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
• locale 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 representing the object's type. Objects of the same type share the same value.
• on_behalf_of 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 The URL to redirect customers to when they click on the portal's link to return to your website.
• url The short-lived URL of the session that gives customers access to the customer portal.