Skip to content

Get Usage

GET
/usage

Current credit balance for the authenticated org — total, held, available, and lifetime totals.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An org’s current credit balance + lifetime totals.

object
available_credits
required

Spendable credits (credits - held)

number
credits
required

Total credit balance

number
customer_id
required

Org / customer id the credits belong to

string
held_credits
required

Credits currently on hold

number
total_earned
required

Lifetime credits earned

number
total_used
required

Lifetime credits used

number
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string