GET
/
customers
/
external_customer_id
/
{external_customer_id}
/
credits
Fetch customer credit balance by external customer id
curl --request GET \
  --url https://api.withorb.com/v1/customers/external_customer_id/{external_customer_id}/credits \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "balance": 123,
      "effective_date": "2023-11-07T05:31:56Z",
      "expiry_date": "2023-11-07T05:31:56Z",
      "per_unit_cost_basis": "<string>",
      "status": "active",
      "maximum_initial_balance": 123
    }
  ],
  "pagination_metadata": {
    "has_more": true,
    "next_cursor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Path Parameters

​
external_customer_id
string | null
required

Query Parameters

​
limit
integer
default:20

The number of items to fetch. Defaults to 20.

Required range: 1 <= x <= 100
​
cursor
string | null

Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.

​
currency
string | null

The ledger currency or custom pricing unit to use.

​
include_all_blocks
boolean
default:false

If set to True, all expired and depleted blocks, as well as active block will be returned.

Response

200
application/json

OK

The response is of type object.