Skip to main content
POST
Typescript (SDK)

Body Parameters

Response

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-version
string
default:2.3.0
required

Body

application/json
customer_id
string
required

The ID of the customer to open the billing portal for.

configuration_id
string

Stripe billing portal configuration ID. Create configurations in your Stripe dashboard.

return_url
string

URL to redirect to when back button is clicked in the billing portal

Response

200 - application/json

OK

customer_id
string
required

The ID of the billing portal session

url
string
required

URL to the billing portal