Skip to main content
GET
/
v1
/
invoices
/
{id}
Get invoice
curl --request GET \
  --url https://api.quentli.com/v1/invoices/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "inv_1234567890abcdefghij",
  "createdAt": "2025-01-10T12:00:00.000Z",
  "updatedAt": "2025-01-10T12:00:00.000Z",
  "customerId": "cus_1234567890abcdefghij",
  "collectionMethod": "SEND_REMINDER",
  "totalAmount": 150000,
  "currency": "MXN",
  "dueDate": "2025-02-01T06:00:00.000Z",
  "organizationId": "org_1234567890abcdefghij",
  "isPaid": false,
  "amountPaid": 0,
  "allowOfftimePayment": false,
  "items": [
    {
      "id": "invi_1234567890abcdefghij",
      "description": "Colegiatura Enero 2025",
      "conceptId": "pc_1234567890abcdefghij",
      "concept": null,
      "quantity": 1
    }
  ],
  "subscriptionId": "sub_1234567890abcdefghij",
  "expireDate": null,
  "paidById": null,
  "beneficiaryId": null,
  "paidWithId": null,
  "canceledAt": null,
  "canceledById": null,
  "meta": {
    "Ciclo Escolar": "2025-1"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Identifier of the invoice.

Response

object | null

Invoice details

Invoice details response. Returns null if the invoice does not exist.

​
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"

​
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"

​
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

​
amountPaid
number
required

Total amount paid so far in minor units.

Example:

0

​
allowOfftimePayment
boolean
required

Whether payment is accepted outside the due window.

Example:

false

​
items
object[]
required

Line items included in this invoice.

Example:
[
  {
    "id": "invi_1234567890abcdefghij",
    "description": "Colegiatura Enero 2025",
    "conceptId": "pc_1234567890abcdefghij",
    "concept": null,
    "quantity": 1
  }
]
​
subscriptionId
string | null

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

Example:

"sub_1234567890abcdefghij"

​
expireDate

Date and time when the invoice expires.

Example:

null

​
paidById
string | null

Identifier of the customer who paid the invoice.

Example:

null

​
beneficiaryId
string | null

Identifier of the beneficiary customer, if any.

Example:

null

​
paidWithId
string | null

Identifier of the payment that settled the invoice.

Example:

null

​
canceledAt

Date and time when the invoice was canceled.

Example:

null

​
canceledById
string | null

Identifier of the user who canceled the invoice.

Example:

null

​
meta
object

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

Example:
{ "Ciclo Escolar": "2025-1" }