OpenAPI 3.1.02026-08-051856761.1 MB
964f974aceff
customers
public
Get Customer State by External ID
Get a customer state by external ID.
The customer state includes information about the customer's active subscriptions and benefits.
It's the ideal endpoint to use when you need to get a full overview of a customer's status.
Scopes: customers:read customers:write
get/v1/customers/external/{external_id}/state
Path parameters
external_idstring required
The customer external ID.
The customer external ID.
Response
Successful Response
CustomerState required— unresolved $ref