Creates a customer portal session for a customer.
The customer portal is a secure, Paddle-hosted site that allows customers to manage their own subscriptions, payments, and account information without you having to build custom billing screens.
Customers can:
You can create a customer portal session to generate authenticated links for a customer so that they’re automatically signed in to the portal. It’s typically used when linking to the customer portal from your app where customers are already authenticated.
You can include an array of subscription_ids to generate authenticated portal links that let customers make
changes to their subscriptions. You can use these links as part of subscription management workflows rather than
building your own billing screens.
Customer portal sessions are temporary and shouldn’t be cached.
The customer portal is fully hosted by Paddle. For security and the best customer experience, don’t embed the customer portal in an iframe.
Requests are authenticated with API keys. Provide your API key as a Bearer token in the Authorization header.
API keys are assigned permissions, granting them access to entities and operations.
Each endpoint may require one or more permissions, defined with the x-permissions extension.
Values for include parameters may require specific permissions as defined in the x-enum-permissions extension.
See all available permissions in the permission schema or documentation.
Get an API key and select the permissions you need from the Paddle dashboard under Paddle > Developer Tools > Authentication.
Paddle ID of the customer entity to work with.
"ctm_01gw1xk43eqy2rrf0cs93zvm6t"
Represents a customer portal session creation request.
List of subscriptions to create authenticated customer portal deep links for.
25Paddle ID of a subscription related to this customer to create an authenticated customer portal deep link for.