API referenceBilling
Open the card billing portal
POST
Returns a hosted Polar customer-portal URL for managing the card subscription (update card, cancel at period end). Crypto subscriptions renew manually and have no portal.
CognitoUserPoolheader
AuthorizationBearer <token>Cognito user pool ID token. API Gateway validates the token (identity
token: no OAuth scopes are configured on the authorizer) and forwards
its claims; the sub claim is the tenant key.
Hosted portal URL.
application/json- response
checkout_url*stringHosted checkout or customer-portal URL to redirect to.
Format
uricurl -X POST "https://example.com/billing/portal"{ "checkout_url": "http://example.com"}