Search documentation of tiger_stripe

# Stripe.Resources.BillingPortal.Session (tiger_stripe v0.1.1)

Copy Markdown View Source

PortalSession

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.

Related guide: Customer management

## Summary

### Types

t()

### Functions

expandable_fields()
object_name()

## Types

# t()

    @type t() :: %Stripe.Resources.BillingPortal.Session{
      configuration: String.t() | map(),
      created: integer(),
      customer: String.t(),
      customer_account: String.t(),
      flow: map(),
      id: String.t(),
      livemode: boolean(),
      locale: String.t(),
      object: String.t(),
      on_behalf_of: String.t(),
      return_url: String.t(),
      url: String.t()
    }

- `configuration` - The configuration used by this session, describing the features available. Expandable.
- `created` - Time at which the object was created. Measured in seconds since the Unix epoch. Format: Unix timestamp.
- `customer` - The ID of the customer for this session. Max length: 5000.
- `customer_account` - The ID of the account for this session. Max length: 5000. Nullable.
- `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. Nullable. Expandable.
- `id` - Unique identifier for the object. Max length: 5000.
- `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. Possible values: `auto`, `bg`, `cs`, `da`, `de`, `el`, `en`, `en-AU`, `en-CA`, `en-GB`, `en-IE`, `en-IN`, `en-NZ`, `en-SG`, `es`, `es-419`, `et`, `fi`, `fil`, `fr`, `fr-CA`, `hr`, `hu`, `id`, `it`, `ja`, `ko`, `lt`, `lv`, `ms`, `mt`, `nb`, `nl`, `pl`, `pt`, `pt-BR`, `ro`, `ru`, `sk`, `sl`, `sv`, `th`, `tr`, `vi`, `zh`, `zh-HK`, `zh-TW`. Nullable.
- `object` - String representing the object's type. Objects of the same type share the same value. Possible values: `billing_portal.session`.
- `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. Max length: 5000. Nullable.
- `return_url` - The URL to redirect customers to when they click on the portal's link to return to your website. Max length: 5000. Nullable.
- `url` - The short-lived URL of the session that gives customers access to the customer portal. Max length: 5000.

## Functions

# expandable_fields()

# object_name()