Defines the object schema located at components.schemas.billing_portal.session in the specification.
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.
Constructors
BillingPortal'sessionbillingPortal'sessionConfiguration :: BillingPortal'sessionConfiguration'Variantsconfiguration: The configuration used by this session, describing the features available.
billingPortal'sessionCreated :: Intcreated: Time at which the object was created. Measured in seconds since the Unix epoch.
billingPortal'sessionCustomer :: Textcustomer: The ID of the customer for this session.
Constraints:
Maximum length of 5000
billingPortal'sessionId :: Textid: Unique identifier for the object.
Constraints:
Maximum length of 5000
billingPortal'sessionLivemode :: Boollivemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
billingPortal'sessionLocale :: Maybe (Nullable BillingPortal'sessionLocale'NonNullable)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.
billingPortal'sessionOnBehalfOf :: Maybe (Nullable Text)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.
Constraints:
Maximum length of 5000
billingPortal'sessionReturnUrl :: Maybe (Nullable Text)return_url: The URL to redirect customers to when they click on the portal's link to return to your website.
Constraints:
Maximum length of 5000
billingPortal'sessionUrl :: Texturl: The short-lived URL of the session that gives customers access to the customer portal.
Constraints:
Maximum length of 5000
Instances4Eq, Show, FromJSON, ToJSON
Eq BillingPortal'sessionDefined in stripeapi-3.0.0.0 · StripeAPI.Types.BillingPortal_SessionShow BillingPortal'sessionDefined in stripeapi-3.0.0.0 · StripeAPI.Types.BillingPortal_SessionFromJSON BillingPortal'sessionDefined in stripeapi-3.0.0.0 · StripeAPI.Types.BillingPortal_SessionToJSON BillingPortal'sessionDefined in stripeapi-3.0.0.0 · StripeAPI.Types.BillingPortal_Session