Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Payment Records
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Webhooks

The Customer Portal Session object 

Attributes

  • idstring

    Unique identifier for the object.

  • objectstring

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

  • configurationstringExpandable

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

  • createdtimestamp

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

  • customerstring

    The ID of the customer for this session.

  • customer_accountnullable string

    The ID of the account for this session.

  • flownullable 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.

  • livemodeboolean

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

  • localenullable enum

    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.

  • on_behalf_ofnullable stringConnect only

    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_urlnullable string

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

  • urlstring

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

The Customer Portal Session object
{
  "id": "bps_1MrSjzLkdIwHu7ixex0IvU9b",
  "object": "billing_portal.session",
  "configuration": "bpc_1MAhNDLkdIwHu7ixckACO1Jq",
  "created": 1680210639,
  "customer": "cus_NciAYcXfLnqBoz",
  "flow": null,
  "livemode": false,
  "locale": null,
  "on_behalf_of": null,
  "return_url": "https://example.com/account",
  "url": "https://billing.stripe.com/p/session/test_YWNjdF8xTTJKVGtMa2RJd0h1N2l4LF9OY2lBYjJXcHY4a2NPck96UjBEbFVYRnU5bjlwVUF50100BUtQs3bl"
}

Create a portal session 

Creates a session of the customer portal.

Parameters

  • configurationstring

    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.

  • customerstring

    The ID of an existing customer.

  • customer_accountstring

    The ID of an existing account.

  • flow_dataobject

    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.

  • localeenum

    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.

  • on_behalf_ofstringConnect 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_urlstring

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

Returns

Returns a portal session object.

POST /v1/billing_portal/sessions
curl https://api.stripe.com/v1/billing_portal/sessions \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d customer=cus_NciAYcXfLnqBoz \
  --data-urlencode return_url="https://example.com/account"
Response
{
  "id": "bps_1MrSjzLkdIwHu7ixex0IvU9b",
  "object": "billing_portal.session",
  "configuration": "bpc_1MAhNDLkdIwHu7ixckACO1Jq",
  "created": 1680210639,
  "customer": "cus_NciAYcXfLnqBoz",
  "flow": null,
  "livemode": false,
  "locale": null,
  "on_behalf_of": null,
  "return_url": "https://example.com/account",
  "url": "https://billing.stripe.com/p/session/test_YWNjdF8xTTJKVGtMa2RJd0h1N2l4LF9OY2lBYjJXcHY4a2NPck96UjBEbFVYRnU5bjlwVUF50100BUtQs3bl"
}