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.

  Show child attributes

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

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.

  Show child parameters

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