GET
/
customers
/
{customer_id}
/
balance_transactions
curl --request GET \
  --url https://api.withorb.com/v1/customers/{customer_id}/balance_transactions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "cgZa3SXcsPTVyC4Y",
      "created_at": "2022-05-01T07:01:31+00:00",
      "starting_balance": "33.00",
      "ending_balance": "22.00",
      "amount": "11.00",
      "action": "applied_to_invoice",
      "description": "An optional description",
      "invoice": {
        "id": "gXcsPTVyC4YZa3Sc"
      },
      "type": "increment",
      "credit_note": {
        "id": "<string>"
      }
    }
  ],
  "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

customer_id
string
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.

operation_time[gte]
string | null
operation_time[gt]
string | null
operation_time[lt]
string | null
operation_time[lte]
string | null

Response

200
application/json
OK
data
object[]
required
pagination_metadata
object
required