Sample - Stripe API
GET/v1/billing_portal/configurations/{configuration}

Retrieve a portal configuration

Retrieves a customer portal configuration by its identifier. Use expand to include expanded fields in the returned configuration, which describes the portal features and behavior available to customers.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
configurationstringrequired
The unique identifier of the customer portal configuration to retrieve.
expandarray<string>optional
Fields to expand in the response; each entry must be no longer than 5000 characters.

2 status codes
200Returns the customer portal configuration, including its active state, features, business profile, default status, and timestamps.
activebooleanrequired
Whether the configuration is active and can be used to create portal sessions.
applicationstringoptional
ID of the Connect Application that created the configuration.
business_profileobjectrequired
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
default_return_urlstringoptional
The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overridden](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
featuresobjectrequired
idstringrequired
Unique identifier for the object.
is_defaultbooleanrequired
Whether the configuration is the default. If `true`, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
login_pageobjectrequired
metadataobjectoptional
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
namestringoptional
The name of the configuration.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:billing_portal.configuration
updatedintegerrequired
Time at which the object was last updated. Measured in seconds since the Unix epoch.
defaultReturns an error object containing details about the failed request.
errorobjectrequired

Error handling

configuration must be a string no longer than 5000 characters. Each value in expand must be a string no longer than 5000 characters.