Skip to main content
GET
Get point balance

Authorizations

X-Channel-Id
string
header
required

Merchant storefront identifier. Provided during onboarding.

X-Session-Id
string
header
required

Diner session identifier from the Storefront API's GET /channel. Log in returns a new one.

Response

The diner's balance

points
integer
value
number

Worth of points, in cents

expiring_points
integer

Points that expire in the next month

expiring_value
number

Worth of expiring_points, in cents