POST /v1/billing_portal/configurations
Creates a configuration that describes the functionality and behavior of a PortalSession
Servers
- https://api.stripe.com/
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
business_profile |
Object | No |
The business information shown to customers in the portal. |
business_profile.headline |
No | ||
business_profile.terms_of_service_url |
String | No | |
business_profile.privacy_policy_url |
String | No | |
login_page |
Object | No |
The hosted login page for this configuration. Learn more about the portal login page in our integration docs. |
login_page.enabled |
Boolean | Yes | |
metadata |
Object | No |
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 |
features |
Object | Yes |
Information about the features available in the portal. |
features.payment_method_update |
Object | No | |
features.payment_method_update.enabled |
Boolean | Yes | |
features.subscription_update |
Object | No | |
features.subscription_update.products |
No | ||
features.subscription_update.enabled |
Boolean | Yes | |
features.subscription_update.proration_behavior |
String | No |
Possible values:
|
features.subscription_update.default_allowed_updates |
No | ||
features.subscription_update.schedule_at_period_end |
Object | No | |
features.subscription_update.schedule_at_period_end.conditions[] |
Array | No | |
features.subscription_update.schedule_at_period_end.conditions[].type |
String | Yes |
Possible values:
|
features.customer_update |
Object | No | |
features.customer_update.allowed_updates |
No | ||
features.customer_update.enabled |
Boolean | Yes | |
features.invoice_history |
Object | No | |
features.invoice_history.enabled |
Boolean | Yes | |
features.subscription_cancel |
Object | No | |
features.subscription_cancel.cancellation_reason |
Object | No | |
features.subscription_cancel.cancellation_reason.options |
Yes | ||
features.subscription_cancel.cancellation_reason.enabled |
Boolean | Yes | |
features.subscription_cancel.enabled |
Boolean | Yes | |
features.subscription_cancel.mode |
String | No |
Possible values:
|
features.subscription_cancel.proration_behavior |
String | No |
Possible values:
|
default_return_url |
No |
The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overriden when creating the session. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.