Skip to main content

BillingPortalRequestDto

flowstring

overview = landing page (default). cancel = deep-link to Stripe cancellation page; requires subscriptionId.

Possible values: [overview, cancel]

Default value: overview
returnUrlstring

Where to send the user after they finish in the portal. Must match an allowed origin.

subscriptionIdstring

Local subscription id. Required when flow === "cancel".

BillingPortalRequestDto
{
"flow": "overview",
"returnUrl": "string",
"subscriptionId": "string"
}