Retrieve a portal configuration
GET / v1 / billing_portal / configurations /:id
Retrieves a configuration that describes the functionality of the customer portal.
Parameters
No parameters.
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}
List portal configurations
GET / v1 / billing_portal / configurations
Returns a list of configurations that describe the functionality of the customer portal.
Parameters
- active boolean Only return configurations that are active or inactive (e.g., pass
trueto only list active configurations). - is _ default boolean Only return the default or non-default configurations (e.g., pass
trueto only list the default configuration).
More parameters
- ending _ before string
- limit integer
- starting _ after string
Returns
Returns a list of portal configuration objects.
Response