Create a portal session

POST / v1 / billing_portal / sessions

Creates a session of the customer portal.

configuration string The ID of an existing configuration to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
customer string The ID of an existing customer.
customer _ account string The ID of an existing account.
flow _ data object 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.
locale enum The the related setting 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.
on _ behalf _ of string Connect only The on_behalf_of account to use for this session. 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 default URL to redirect customers to when they click on the portal’s link to return to your website.

Returns a portal session object.

Response