Get Invoices

This request returns a list of invoices.

get	/billing/invoices

Sample

A sample GET request to get invoices matching the criteria in the request URL:

curl -X GET \
'https://api.carrierx.com/core/v2/billing/invoices?limit=1' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

200 status code with a list of Invoice objects:

{
    "count": 1,
    "has_more": true,
    "items": [
        {
            "amount": "0.38",
            "amount_due": "0",
            "amount_tax": "0.32",
            "balance_forward": "-0.45",
            "balance_previous": "-351.91",
            "date_billing_period_end": "2025-01-19T23:59:59.000Z",
            "date_billing_period_start": "2024-12-20T00:00:00.000Z",
            "date_charge_expected": "2025-01-19T23:59:59.000Z",
            "date_charged": null,
            "date_created": "2024-12-19T23:30:01.000Z",
            "date_issued": null,
            "display_id": "004",
            "invoice_items": [
                {
                    "amount": "0.37",
                    "country_code": "USA",
                    "date_billing_period_end": "2025-01-19T23:59:59.000Z",
                    "date_billing_period_start": "2024-12-20T00:00:00.000Z",
                    "direction": "inbound",
                    "type": "toll",
                    "usage": 8880
                },
                {
                    "amount": "0.01",
                    "country_code": "USA",
                    "date_billing_period_end": "2025-01-19T23:59:59.000Z",
                    "date_billing_period_start": "2024-12-20T00:00:00.000Z",
                    "direction": "outbound",
                    "type": "toll",
                    "usage": 60
                },
                {
                    "amount": "0",
                    "country_code": "USA",
                    "date_billing_period_end": "2023-07-04T23:59:59.000Z",
                    "date_billing_period_start": "2023-06-06T00:00:00.000Z",
                    "type": "sms_enablement",
                    "usage": 2
                }
            ],
            "invoice_sid": "4169705e-4284-482f-8e72-e962a8aaad9d",
            "paid": false,
            "partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
            "pay_items": [],
            "status": "open",
            "tax_items": [
                {
                    "amount": "0.32",
                    "jurisdiction": "federal",
                    "type": "fed_universal_service_fund"
                }
            ]
        }
    ],
    "limit": 1,
    "offset": 0,
    "pagination": {
        "next": "https://api.carrierx.com/core/v2/billing/invoices?limit=1&offset=1"
    },
    "total": 4
}

This request is enabled for Pagination, Result Filtering, and Field Filtering.

Required Scopes

To get information about Invoice objects, the partner must have one of the following scopes enabled:

• invoices.manage
• invoices.read

Query Arguments

Parameter	Data Type	Description
with_related	boolean	Determines if the partner information related to the invoice should be shown. Values accepted in this field are true and false. The default value is false.