Create customer portal session API Reference
POST /tenants/{tenant}/billing/portal-session
Creates a fresh, authenticated Paddle customer-portal session for the tenant and returns its deep links: the portal overview page (invoices, payments, saved payment methods) and — when the tenant has a linked payment-method subscription — the update-payment-method form. Use this to update the card on file (e.g. to recover a PastDue invoice); Paddle retries failed charges automatically once the payment method is fixed. The returned URLs are short-lived and authenticated — open them immediately; do NOT store them. Create a new session each time. Requires admin role.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Tenant name
Responses
Section titled “ Responses ”Fresh portal URLs (short-lived — do not store)
object
OverviewURL is the authenticated customer-portal overview page (invoices, payments, saved payment methods).
Example
https://customer-portal.paddle.com/cpl_01x/overview?token=...UpdatePaymentMethodURL opens the portal with the payment-method update form pre-opened for the tenant’s payment-method subscription. Omitted when the tenant has no linked subscription yet.
Example
https://customer-portal.paddle.com/cpl_01x/subscriptions/sub_01y/update-payment-method?token=...Missing or invalid authentication
object
Not an admin of this tenant
object
Tenant not found
object
Tenant has no billing profile yet
object
Rate limit exceeded
object
Billing integration not configured or Paddle unavailable