Credit
Fetch customer credit balance
Returns a paginated list of unexpired, non-zero credit blocks for a customer.
If include_all_blocks
is set to true
, all credit blocks (including expired and depleted blocks) will be included in
the response.
Note that currency
defaults to credits if not specified. To use a real world currency, set currency
to an ISO 4217 string.
GET
Authorizations
API Keys can be issued in the Orb's web application.
Path Parameters
Query Parameters
The number of items to fetch. Defaults to 20.
Required range:
1 < x < 1000
Cursor for pagination. This can be populated by the next_cursor
value returned from the initial request.
The ledger currency or custom pricing unit to use.
If set to True, all expired and depleted blocks, as well as active block will be returned.
Was this page helpful?