Generate a portal token for a customer
Customers
Generate a portal token for a customer
Generates a JWT token that grants access to the customer portal. The token can be used to access invoices, payment methods, and other portal features.
POST
Generate a portal token for a customer
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
customer ID or alias
Body
application/json
Token lifetime in seconds. Defaults to 86400 (24 hours). Must be between 60 and 2592000 (30 days).
Required range:
x >= 0Scopes granted to the token. Defaults to ["read", "manage"].
Use ["read"] for tokens that only read billing state, e.g. to gate features in a browser.
Minimum array length:
1What a customer portal token may do.
Available options:
read, manage Response
Portal token generated