Get an invoice

curl --request GET \
  --url https://api.metronome.com/v1/customers/{customer_id}/invoices/{invoice_id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "6a37bb88-8538-48c5-b37b-a41c836328bd",
    "customer_id": "617e39d8-68f4-4592-b8d2-c2bf26a76989",
    "type": "USAGE",
    "start_timestamp": "2021-01-01T00:00:00Z",
    "end_timestamp": "2021-02-01T00:00:00Z",
    "credit_type": {
      "id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
      "name": "USD (cents)"
    },
    "contract_id": "9de042a1-b955-43ce-9ab4-e3c2004570d1",
    "line_items": [
      {
        "credit_type": {
          "id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
          "name": "USD (cents)"
        },
        "name": "CPU hours",
        "type": "usage",
        "quantity": 1488,
        "total": 14392,
        "product_id": "5c1f40cd-9ff8-4e90-ae53-5f81b0e9d1e8"
      }
    ],
    "total": 14392,
    "status": "FINALIZED"
  }
}

Invoices

Get an invoice

Retrieve detailed information for a specific invoice by its unique identifier. This endpoint returns comprehensive invoice data including line items, applied credits, totals, and billing period details for both finalized and draft invoices.

Use this endpoint to:

Display historical invoice details in customer-facing dashboards or billing portals.
Retrieve current month draft invoices to show customers their month-to-date spend.
Access finalized invoices for historical billing records and payment reconciliation.
Validate customer pricing and credit applications for customer support queries.

Key response fields:

Invoice status (DRAFT, FINALIZED, VOID) Billing period start and end dates Total amount and amount due after credits Detailed line items broken down by:

Customer and contract information
Invoice line item type
Product/service name and ID
Quantity consumed
Unit and total price
Time period for usage-based charges
Applied credits or prepaid commitments

Usage guidelines:

Draft invoices update in real-time as usage is reported and may change before finalization
The response includes both usage-based line items (e.g., API calls, data processed) and scheduled charges (e.g., monthly subscriptions, commitment fees)
Credit and commitment applications are shown as separate line items with negative amounts
For voided invoices, the response will indicate VOID status but retain all original line item details

GET

customers

{customer_id}

invoices

{invoice_id}

Get an invoice

curl --request GET \
  --url https://api.metronome.com/v1/customers/{customer_id}/invoices/{invoice_id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "6a37bb88-8538-48c5-b37b-a41c836328bd",
    "customer_id": "617e39d8-68f4-4592-b8d2-c2bf26a76989",
    "type": "USAGE",
    "start_timestamp": "2021-01-01T00:00:00Z",
    "end_timestamp": "2021-02-01T00:00:00Z",
    "credit_type": {
      "id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
      "name": "USD (cents)"
    },
    "contract_id": "9de042a1-b955-43ce-9ab4-e3c2004570d1",
    "line_items": [
      {
        "credit_type": {
          "id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
          "name": "USD (cents)"
        },
        "name": "CPU hours",
        "type": "usage",
        "quantity": 1488,
        "total": 14392,
        "product_id": "5c1f40cd-9ff8-4e90-ae53-5f81b0e9d1e8"
      }
    ],
    "total": 14392,
    "status": "FINALIZED"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customer_id

string<uuid>

required

invoice_id

string<uuid>

required

Query Parameters

skip_zero_qty_line_items

boolean

If set, all zero quantity line items will be filtered out of the response

Response

Success

The response is of type object.

Delete custom fields

List invoices

GET STARTED

API REFERENCE

Get an invoice

Use this endpoint to:

Key response fields:

Usage guidelines:

Authorizations

Path Parameters

Query Parameters

Response