v1

latestOpenAPI 3.1.12026-07-17111158225.7 KB

billing

List billing charges

Lists the billing charges for the account.

get/{account}/billing/charges

Path parameters

accountinteger required

The account id

Query parameters

start_datestring date

A date value formatted as ISO 8601.

Example:2010-01-01

Only include results after the given date. Format is ISO8601 (YYYY-MM-DD).

end_datestring date

A date value formatted as ISO 8601.

Example:2010-01-01

Only include results before the given date. Format is ISO8601 (YYYY-MM-DD).

sort'invoiced:asc' | 'invoiced:desc'

Sort results. Default sorting is by invoiced ascending.

Response

Billing charges listing.

Example response

{
  "data": [
    {
      "invoiced_at": "2017-03-03T13:49:58.000Z",
      "total_amount": "50.00",
      "balance_amount": "50.00",
      "reference": "20170303-0001",
      "state": "collected",
      "items": [
        {
          "description": "Auto Renew example.com",
          "amount": "50.00",
          "product_id": 153,
          "product_type": "domain-renewal",
          "product_reference": "example.com"
        }
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 30,
    "total_entries": 2,
    "total_pages": 1
  }
}