Skip to main content
POST
/
api
/
billing
/
portal
Billing Portal
curl --request POST \
  --url https://api.example.com/api/billing/portal \
  --header 'Content-Type: application/json' \
  --header 'X-Organization-Id: <x-organization-id>' \
  --data '
{
  "return_url": "<string>"
}
'
{
  "portal_url": "https://portal.dodopayments.com/session/ps_ghi789"
}
Generate a secure portal link for an organization to manage their subscription. Users can cancel subscriptions, update payment methods, and view historical invoices.

Request

X-Organization-Id
string
required
The unique identifier of the organization.
return_url
string
required
The URL where the user should be redirected after finishing their session in the billing portal.

Response

portal_url
string
The unique, temporary URL to access the Dodo Payments customer portal.
{
  "portal_url": "https://portal.dodopayments.com/session/ps_ghi789"
}