Skip to main content
GET
List invoices

Editor interactivo de filter

Utiliza este editor para generar un valor que puedes usar en el parámetro filter del query string. Para relaciones, grupos lógicos y más ejemplos, consulta la guía de filtros.

Authorizations

Authorization
string
header
required

Organization API key using Authorization: Bearer sk_....

Query Parameters

filter
object

Filter fields encoded with qs bracket notation.

skip
number
default:0

Pagination offset.

Required range: x >= 0
Example:

0

take
number
default:20

Pagination limit.

Required range: 1 <= x <= 100
Example:

20

orderBy
object

Sort fields encoded with qs bracket notation.

Response

Invoices list

id
string
required

Unique identifier of the invoice.

Example:

"inv_1234567890abcdefghij"

createdAt
required

Date and time when the invoice was created.

Example:

"2025-01-10T12:00:00.000Z"

updatedAt
required

Date and time when the invoice was last updated.

Example:

"2025-01-10T12:00:00.000Z"

customerId
string
required

Identifier of the customer this invoice belongs to.

Example:

"cus_1234567890abcdefghij"

subscriptionId
string | null
required

Identifier of the subscription that generated this invoice, if any.

Example:

"sub_1234567890abcdefghij"

collectionMethod
enum<string>
required

How payment is collected: AUTOMATIC, SEND_REMINDER, or NONE.

Available options:
AUTOMATIC,
SEND_REMINDER,
NONE
Example:

"SEND_REMINDER"

totalAmount
number
required

Computed total amount of the invoice in minor units.

Example:

150000

currency
string
required

ISO 4217 currency code for the invoice.

Example:

"MXN"

dueDate
required

Date and time when payment is due.

Example:

"2025-02-01T06:00:00.000Z"

expireDate
required

Date and time when the invoice expires.

Example:

null

organizationId
string
required

Identifier of the organization that owns this invoice.

Example:

"org_1234567890abcdefghij"

isPaid
boolean
required

Whether the invoice has been fully paid.

Example:

false

paidById
string | null
required

Identifier of the customer who paid the invoice.

Example:

null

amountPaid
number
required

Total amount paid so far in minor units.

Example:

0

beneficiaryId
string | null
required

Identifier of the beneficiary customer, if any.

Example:

null

allowOfftimePayment
boolean
required

Whether payment is accepted outside the due window.

Example:

false

paidWithId
string | null
required

Identifier of the payment that settled the invoice.

Example:

null

canceledAt
required

Date and time when the invoice was canceled.

Example:

null

canceledById
string | null
required

Identifier of the user who canceled the invoice.

Example:

null

items
object[]
required
metadata
object[] | null

Structured metadata entries attached to the invoice.

Example:
meta
object | null

Flattened metadata map where each key maps to a string value.

Example: