Sign in
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

Changes

Changed in 1 of the 11 revisions of this API.2

  • f9688fd328d62See the full diff
    • ○

      added the required property oneOf[subschema #1: CustomerStateIndividual]/first_user_event_at to the response with the 200 status

      response-required-property-added

    • ○

      added the required property oneOf[subschema #2: CustomerStateTeam]/first_user_event_at to the response with the 200 status

      response-required-property-added