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

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

Changed in 4 of the 54 revisions of this API.134

  • v1de35c02bb0d231See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

  • v1665f680338b52See the full diff
    • ○

      api tag Customers added

      api-tag-added

    • ○

      api tag customer removed

      api-tag-removed

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v12244ec0dabe31See the full diff
    • ○

      endpoint added

      endpoint-added

  • v1dece17f86f991See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 274 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog