provider POST /v1/billing_portal/configurations
@utdk/stripe /v1/billing_portal/configurations
Create a portal configuration
<p>Creates a configuration that describes the functionality and behavior of a PortalSession</p>

Try it

Authentication
Configure credentials for Stripe API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

postbillingportalconfigurations
POST/v1/billing_portal/configurations
<p>Creates a configuration that describes the functionality and behavior of a PortalSession</p>

Input

The business information shown to customers in the portal.

The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.

Specifies which fields in the response should be expanded.

required

Information about the features available in the portal.

The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

The name of the configuration.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import stripe from '@utdk/stripe';

await stripe.postbillingportalconfigurations()