Skip to main content
GET
Get customer state

Authorizations

Authorization
string
header
required

Your account's secret key: Authorization: Bearer sk_test_… or sk_live_…. Server-side only.

Path Parameters

customerID
string<uuid>
required

ID of the customer's enrollment in the product (not the customer ID).

Response

Customer state.

The customer's state in one read: the enrollment, each meter's balance, live subscriptions and current-period usage.

customer
object
required

The enrollment.

balances
object[]
required

One balance per meter.

subscriptions
object[]
required

Live subscriptions, with their items.

usage
object
required

Current-period usage.