Get Customer Portal

Get Customer Portal

curl --request GET \
  --url https://api.example.com/v1/billing/portal \
  --header 'Authorization: Bearer <token>'

{
  "portal_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}

GET

billing

portal

Get Customer Portal

curl --request GET \
  --url https://api.example.com/v1/billing/portal \
  --header 'Authorization: Bearer <token>'

{
  "portal_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}

Authorization

string

header

required

JWT Bearer token for dashboard access

return_url

string | null

Successful Response

Response with customer portal link.

portal_url

string

required

expires_at

string<date-time> | null

⌘I