The Customer portal configuration object

Attributes

id string Unique identifier for the object.
object string, value is "billing_portal.configuration" String representing the object’s type. Objects of the same type share the same value.
active boolean Whether the configuration is active and can be used to create portal sessions.
application nullable string Expandable Connect only ID of the Connect Application that created the configuration.
business _ profile object The business information shown to customers in the portal.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
default _ return _ url nullable string 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.
features object Information about the features available in the portal.
is _ default boolean 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.
livemode boolean If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
login _ page object The hosted login page for this configuration. Learn more about the portal login page in our integration docs.
metadata nullable map 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.
name nullable string The name of the configuration.
updated timestamp Time at which the object was last updated. Measured in seconds since the Unix epoch.

{ "id": "bpc_1MrnZsLkdIwHu7ixNiQL1xPM", "object": "billing_portal.configuration", "active": true, "application": null, "business_profile": { "headline": null, "privacy_policy_url": null, "terms_of_service_url": null }, "created": 1680290736, "default_return_url": null, "features": { "customer_update": { "allowed_updates": [ "email", "tax_id" ], "enabled": true }, "invoice_history": { "enabled": true }, "payment_method_update": { "enabled": false }, "subscription_cancel": { "cancellation_reason": { "enabled": false, "options": [ "too_expensive", "missing_features", "switched_service", "unused", "other" ] }, "enabled": false, "mode": "at_period_end", "proration_behavior": "none" }, "subscription_update": { "default_allowed_updates": [], "enabled": false, "proration_behavior": "none" } }, "is_default": false, "livemode": false, "login_page": { "enabled": false, "url": null }, "metadata": {}, "updated": 1680290736}

Create a portal configuration

POST / v1 / billing_portal / configurations

Creates a configuration that describes the functionality and behavior of a PortalSession

Parameters

features object Required Information about the features available in the portal.
business _ profile object The business information shown to customers in the portal.
default _ return _ url string 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.
login _ page object The hosted login page for this configuration. Learn more about the portal login page in our integration docs.
metadata map 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
name string The name of the configuration. The maximum length is 256 characters.

Returns

Returns a portal configuration object.

Response

{ "id": "bpc_1MrnZsLkdIwHu7ixNiQL1xPM", "object": "billing_portal.configuration", "active": true, "application": null, "business_profile": { "headline": null, "privacy_policy_url": null, "terms_of_service_url": null }, "created": 1680290736, "default_return_url": null, "features": { "customer_update": { "allowed_updates": [ "email", "tax_id" ], "enabled": true }, "invoice_history": { "enabled": true }, "payment_method_update": { "enabled": false }, "subscription_cancel": { "cancellation_reason": { "enabled": false, "options": [ "too_expensive", "missing_features", "switched_service", "unused", "other" ] }, "enabled": false, "mode": "at_period_end", "proration_behavior": "none" }, "subscription_update": { "default_allowed_updates": [], "enabled": false, "proration_behavior": "none" } }, "is_default": false, "livemode": false, "login_page": { "enabled": false, "url": null }, "metadata": {}, "updated": 1680290736}

Update a portal configuration

POST / v1 / billing_portal / configurations /:id

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

Parameters

active boolean Whether the configuration is active and can be used to create portal sessions.
business _ profile object The business information shown to customers in the portal.
default _ return _ url string 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.
features object Information about the features available in the portal.
login _ page object The hosted login page for this configuration. Learn more about the portal login page in our integration docs.
metadata map 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
name string The name of the configuration. The maximum length is 256 characters.

Returns

Returns a portal configuration object.

Response

{ "id": "bpc_1MrnZsLkdIwHu7ixNiQL1xPM", "object": "billing_portal.configuration", "active": true, "application": null, "business_profile": { "headline": null, "privacy_policy_url": "https://example.com/new_privacy_url", "terms_of_service_url": "https://example.com/new_terms_of_service_url" }, "created": 1680290736, "default_return_url": null, "features": { "customer_update": { "allowed_updates": [ "email", "tax_id" ], "enabled": true }, "invoice_history": { "enabled": true }, "payment_method_update": { "enabled": false }, "subscription_cancel": { "cancellation_reason": { "enabled": false, "options": [ "too_expensive", "missing_features", "switched_service", "unused", "other" ] }, "enabled": false, "mode": "at_period_end", "proration_behavior": "none" }, "subscription_update": { "default_allowed_updates": [], "enabled": false, "proration_behavior": "none" } }, "is_default": false, "livemode": false, "login_page": { "enabled": false, "url": null }, "metadata": {}, "updated": 1688593779}