OpenAPI 3.1.02026-08-101856791.1 MB

f9688fd328d6

customers
public

Get Customer State

Get a customer state by 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/{id}/state

Path parameters

idstring uuid4 required

The customer ID.

The customer ID.

Response

Successful Response

CustomerState required— unresolved $ref