v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Retrieve a portal configuration

Retrieves a configuration that describes the functionality of the customer portal.

get/v1/billing_portal/configurations/{configuration}

Path parameters

configurationstring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

activeboolean required

Whether the configuration is active and can be used to create portal sessions.

createdinteger required

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

default_return_urlstring nullable

The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overridden when creating the session.

idstring required

Unique identifier for the object.

is_defaultboolean required

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.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject nullable

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

namestring nullable

The name of the configuration.

object'billing_portal.configuration' required

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

updatedinteger required

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