Skip to main content
GET
List credits given to a subscriber

Authorizations

Authorization
string
header
required

A signed-in person, not a key: the session token the dashboard holds and agenta login mints, sent as Authorization: Bearer <token>. An API key is REFUSED on the operations that require this, and refusing it is the point — a key belongs to an organization and names nobody, so it cannot be recorded as the person who spent the merchant's money. Unlike a key, a session token carries no environment of its own, so send X-Environment: test or live to choose one; leave it out and you get test, never live money by accident. A session user who belongs to several organizations names one with ?orgId=.

Path Parameters

id
string<uuid>
required

Subscription UUID (the id field from the list response, not stripeSubscriptionId).

Response

The credits given for this subscription.

items
object[]
required
balanceMinor
integer
required

Unspent credit on the CUSTOMER, which may span their subscriptions with you.

currency
string
required

What every minor-unit figure on this page is counted in — the subscription's own currency, lower-case ISO 4217. Print it; don't assume one.