AXaxilioai
billing

Get balance statement

Changed on

The organization's balance over a period, like a bank statement: the starting balance, credit added, what each product used, credit taken back by refunds and chargebacks, credit that expired, and the ending balance.

get/billing/balance/statement

Request

Query parameters

period_start_atstring date-time required

start of the period (RFC 3339)

period_end_atstring date-time required

end of the period, exclusive (RFC 3339)

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

added_microdollarsinteger required

Credit added in microdollars: top-ups, auto-recharge, plan credit and adjustments.

ending_balance_microdollarsinteger required

Balance in microdollars at the end of the period.

expired_microdollarsinteger required

Purchased credit that expired and plan credit that lapsed, in microdollars (zero or negative).

other_microdollarsinteger required

Negative adjustments and balance corrections, in microdollars.

period_end_atstring date-time required

End of the period (exclusive).

period_start_atstring date-time required

Start of the period.

refunded_microdollarsinteger required

Credit taken back by refunds and chargebacks, net of chargebacks won, in microdollars. Usually negative; positive when chargebacks won in the period exceed what was taken back.

starting_balance_microdollarsinteger required

Balance in microdollars at the start of the period.

Example response

{
  "$schema": "/api/v1/SubscriptionBalanceStatement.json"
}

Changes