Skip to main content
POST
Create billing portal session

Authorizations

Authorization
string
header
required

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

Body

application/json

Request schema for creating a billing portal session.

return_path
string
default:/billing

Partial path (e.g. /billing) the portal's 'return to site' link goes to.

Required string length: 1 - 255

Response

Successful Response

Response schema for billing portal session.

url
string<uri>
required

The URL to redirect the customer to access the billing portal.

Required string length: 1 - 2083