Customers

Generate a portal token for a customer

Changed on

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/api/v1/customers/{id_or_alias}/portal-token

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Path parameters

id_or_aliasstring required

customer ID or alias

Response

Portal token generated

portal_urlstring required

Base URL of the customer portal

tokenstring required

JWT token for portal access

Changes

  • v1de35c02bb0d2Revision changes
    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • info

      added the non-success response with the status

  • v1665f680338b5Revision changes
    • info

      api tag Customers added

    • info

      api tag customer removed