Sign in

v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB
Invoices

List Invoices

List invoices

get/v1/invoices

Query parameters

expandstring

Comma-separated list of related objects to expand in the response.

Comma-separated list of related objects to expand in the response.

customerstring nullable

Filter invoices by customer ID

Example:fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Filter invoices by customer ID

starting_afterstring nullable

A cursor for use in pagination. starting_after is an invoice ID that defines your place in the list. For instance, if you make a list request and receive 20 invoices, ending with fin_xyz, your subsequent call can include starting_after=fin_xyz to fetch the next page.

Example:fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA

A cursor for use in pagination. starting_after is an invoice ID that defines your place in the list. For instance, if you make a list request and receive 20 invoices, ending with fin_xyz, your subsequent call can include starting_after=fin_xyz to fetch the next page.

ending_beforestring nullable

A cursor for use in pagination. ending_before is an invoice ID that defines your place in the list. For instance, if you make a list request and receive 20 invoices, starting with fin_abc, your subsequent call can include ending_before=fin_abc to fetch the previous page.

Example:fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA

A cursor for use in pagination. ending_before is an invoice ID that defines your place in the list. For instance, if you make a list request and receive 20 invoices, starting with fin_abc, your subsequent call can include ending_before=fin_abc to fetch the previous page.

limitinteger nullable

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

Example:10

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

Response

An envelope wrapping a list of invoice objects.

Example response

{
  "invoices": [
    {
      "invoice_id": "fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "total": 2500,
      "amount_due": 2500,
      "amount_paid": 2500,
      "charge": "fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "status": "draft",
      "collection_method": "charge_automatically",
      "test_mode": false,
      "metadata": {
        "order_id": "8842",
        "channel": "shopify"
      },
      "created_at": "2026-06-15T14:30:00Z"
    }
  ]
}