Invoice objects represent a billing document, containing line items, payment information, and status tracking.
{
"id": "inv_456789abcdef",
"created_at": "2025-08-01T12:00:00Z",
"currency": "CLP",
"customer": "cus_asdlfknmuy",
"lines": [
{
"id": "il_348nasdfsdf",
"amount": 15000,
"currency": "CLP",
"object_name": "line_item",
"period_end": "2025-09-01T00:00:00Z",
"period_start": "2025-08-01T00:00:00Z",
"quantity": 1
}
],
"metadata": {},
"mode": "live",
"object_name": "invoice",
"payments": [
{
"amount": 15000,
"currency": "CLP",
"payment_intent": "pi_duinkasdfb",
"status": "succeeded"
}
],
"status": "paid",
"subscription": "sub_123489rnas",
"total": 15000
}
| Attribute | Type | Description |
|---|---|---|
id | string | Unique identifier for the Invoice |
created_at | string | Creation date, using ISO 8601 |
currency | string | Currency ISO code. For now, we only support CLP |
customer | string | Customer ID associated with this invoice |
lines | array | List of line item objects |
lines[].id | string | Unique identifier for the line item |
lines[].amount | integer | Amount, represented as an integer |
lines[].currency | string | Currency ISO code. For now, we only support CLP |
lines[].object_name | string | Identifier for the type of object. Its value will always be line_item |
lines[].period_end | string | End of the billing period, using ISO 8601 |
lines[].period_start | string | Start of the billing period, using ISO 8601 |
lines[].quantity | integer | Quantity of items |
metadata | hash | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. It can be null |
mode | string | Indicates whether the Invoice is in live mode or in test mode |
object_name | string | Identifier for the type of object. Its value will always be invoice |
payments | array | List of payment attempt objects |
payments[].amount | integer | Payment amount, represented as an integer |
payments[].currency | string | Currency ISO code. For now, we only support CLP |
payments[].payment_intent | string | Associated Payment Intent ID |
payments[].status | string | Payment status. Can be pending, succeeded or failed |
status | string | Invoice status. Can be open, paid or void |
subscription | string | Subscription ID that generated the invoice, if any. It can be null |
total | integer | Total amount, represented as an integer |