InvoicesPayments and statements

Get a customer's balance

GET
/v1/customers/{id}/balance

What a customer owes you and has paid, with one row for each currency they have been sold in. A customer with no sales has no rows. Every invoiced figure is net of the credit notes issued against those invoices.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.

Path Parameters

id*string

Response Body

Success

application/json
  1. response

Success

data*array<>
curl -X GET "https://example.com/v1/customers/cus_01K6XJ4Q8ZT3M9R5V2B7WDHNCA/balance"
{  "data": [    {      "currency": "USD",      "uninvoiced": 2878,      "open": 2878,      "overdue": 0,      "paid": 2878,      "credited": 0,      "credit": 0    }  ]}