Get Invoices

/api/v1_1/invoices

get
Invoices

https://{domain}.customersuccessbox.com/api/v1_1/invoices
Get Invoices fetches a list of all invoices paginated with a limit of 20 records per page
Request
Response
Request
Headers
Authorization
required
string
Bearer {secret_key}
Content-Type
required
string
application/json
Body Parameters
page
optional
string
Page number to start from
Response
200: OK
"data": [
{
"id": 100021,
"account_id": "100000",
"subscription_id": "100000",
"status": "Paid",
"total": "1000",
"amount_paid": "1000",
"amount_adjusted": "0",
"credits_applied": "0",
"amount_due": "0",
"currency": "USD",
"write_off_amount": "0",
"external_invoice_id": "INV-gXAlA7zIjV",
"external_subscription_id": "SUB-HbyF7XmA7s99",
"created_on": "2018-10-09 00:00:00",
"due_on": "2018-10-18 00:00:00",
"paid_on": "2018-10-09 00:00:00",
"updated_on": "2018-10-09 00:00:00",
"created_at": "2018-10-16 09:40:50",
"updated_at": "2019-01-24 14:26:18",
"external_account_id": null,
"paid_on_for_humans": "6 months ago",
"paid_on_for_date_format": "2018-10-09",
"due_on_for_humans": "6 months ago",
"due_on_for_date_format": "2018-10-18",
"created_on_for_humans": "6 months ago",
"created_on_for_date_format": "2018-10-09",
"updated_on_for_humans": "6 months ago",
"updated_on_for_date_format": "2018-10-09"
},
{
"id": 100022,
"account_id": "100000",
"subscription_id": "100000",
"status": "Paid",
"total": "1000",
"amount_paid": "1000",
"amount_adjusted": "0",
"credits_applied": "0",
"amount_due": "0",
"currency": "USD",
"write_off_amount": "0",
"external_invoice_id": "INV-hDMty2y7Fh",
"external_subscription_id": "SUB-HbyF7XmA7s99",
"created_on": "2018-10-15 00:00:00",
"due_on": "2018-11-01 00:00:00",
"paid_on": "2018-10-15 00:00:00",
"updated_on": "2018-10-15 00:00:00",
"created_at": "2018-10-16 09:41:13",
"updated_at": "2019-01-24 14:26:18",
"external_account_id": null,
"paid_on_for_humans": "6 months ago",
"paid_on_for_date_format": "2018-10-15",
"due_on_for_humans": "5 months ago",
"due_on_for_date_format": "2018-11-01",
"created_on_for_humans": "6 months ago",
"created_on_for_date_format": "2018-10-15",
"updated_on_for_humans": "6 months ago",
"updated_on_for_date_format": "2018-10-15"
},
{
"id": 100023,
"account_id": "100000",
"subscription_id": "100000",
"status": "Paid",
"total": "1000",
"amount_paid": "1000",
"amount_adjusted": "0",
"credits_applied": "0",
"amount_due": "0",
"currency": "USD",
"write_off_amount": "0",
"external_invoice_id": "INV-MBWuPHL0ij",
"external_subscription_id": "SUB-HbyF7XmA7s99",
"created_on": "2018-10-03 00:00:00",
"due_on": "2018-10-15 00:00:00",
"paid_on": "2018-10-03 00:00:00",
"updated_on": "2018-10-03 00:00:00",
"created_at": "2018-10-16 09:44:31",
"updated_at": "2019-01-24 14:26:18",
"external_account_id": null,
"paid_on_for_humans": "6 months ago",
"paid_on_for_date_format": "2018-10-03",
"due_on_for_humans": "6 months ago",
"due_on_for_date_format": "2018-10-15",
"created_on_for_humans": "6 months ago",
"created_on_for_date_format": "2018-10-03",
"updated_on_for_humans": "6 months ago",
"updated_on_for_date_format": "2018-10-03"
},
],
"limit": 20,
"page": 1
}

CURL example

curl --location --request GET "https://{domain}.customersuccessbox.com/api/v1_1/invoices" \
--header "Authorization: Bearer {secret_api_key}" \
--header "Content-Type: application/json" \