A valid request URL is required to generate request examples{
"object": "list",
"data": [
{
"id": "<string>",
"object": "invoice",
"number": "<string>",
"customer": "<string>",
"test_clock": "<string>",
"livemode": true,
"status": "draft",
"collection_method": "charge_automatically",
"allow_save_card": true,
"currency": "<string>",
"lines": [
{
"id": "<string>",
"description": "<string>",
"quantity": 123,
"unit_amount": 123,
"amount": 123,
"currency": "<string>",
"invoice_item": "<string>",
"price": "<string>"
}
],
"subtotal": 123,
"tax": 123,
"total": 123,
"amount_paid": 123,
"amount_remaining": 123,
"attempt_count": 123,
"metadata": {},
"created_at": 123,
"updated_at": 123,
"subscription": "<string>",
"collection_payment_method_id": "<string>",
"due_date": 123,
"finalized_at": 123,
"paid_at": 123,
"voided_at": 123,
"next_payment_attempt_at": 123,
"payment_intent": "<string>",
"max_attempts": 123,
"hosted_invoice_url": "<string>"
}
],
"has_more": true,
"next_cursor": "<string>"
}{
"error": {
"code": "INVALID_DATA",
"message": "invalid currency"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}List invoices
A valid request URL is required to generate request examples{
"object": "list",
"data": [
{
"id": "<string>",
"object": "invoice",
"number": "<string>",
"customer": "<string>",
"test_clock": "<string>",
"livemode": true,
"status": "draft",
"collection_method": "charge_automatically",
"allow_save_card": true,
"currency": "<string>",
"lines": [
{
"id": "<string>",
"description": "<string>",
"quantity": 123,
"unit_amount": 123,
"amount": 123,
"currency": "<string>",
"invoice_item": "<string>",
"price": "<string>"
}
],
"subtotal": 123,
"tax": 123,
"total": 123,
"amount_paid": 123,
"amount_remaining": 123,
"attempt_count": 123,
"metadata": {},
"created_at": 123,
"updated_at": 123,
"subscription": "<string>",
"collection_payment_method_id": "<string>",
"due_date": 123,
"finalized_at": 123,
"paid_at": 123,
"voided_at": 123,
"next_payment_attempt_at": 123,
"payment_intent": "<string>",
"max_attempts": 123,
"hosted_invoice_url": "<string>"
}
],
"has_more": true,
"next_cursor": "<string>"
}{
"error": {
"code": "INVALID_DATA",
"message": "invalid currency"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
A merchant secret key (sk_…) sent as Authorization: Bearer <key>.
Headers
Merchant ID when an authorized Platform acts for a connected Merchant. Omit when authenticating directly as that Merchant.
^mer_[0-9A-Za-z]{14}$Query Parameters
Filter by customer id. Mutually exclusive with subscription.
Filter to the invoices generated by one subscription, newest first. Mutually exclusive with customer.
Filter by status.
draft, open, paid, void, uncollectible Page size (default 20, max 100).
1 <= x <= 100Number of records to skip.
x >= 0Cursor: a invoice id (typically the previous response's next_cursor). Returns results strictly after it, newest first. Cannot be combined with offset.
Response
A paginated list of invoices.
list The invoices on this page.
Show child attributes
Show child attributes
True when more records exist beyond this page.
Present when has_more is true: the last returned invoice's id. Pass it as starting_after on the next request.

