List Invoices

GET

/api/:account_id/invoices/

GET

/api/:account_id/invoices/

$ curl https://app.paymentkit.com/api/account_id/invoices/ \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "items": [
3     {
4       "id": "inv_8f3b2c9d7a1e4b2f",
5       "customer_id": "cus_92a7d4e5f6b8c1d2",
6       "status": "open",
7       "currency": "usd",
8       "subtotal_amount_atom": 150000,
9       "tax_amount_atom": 12000,
10       "total_amount_atom": 162000,
11       "due_amount_atom": 162000,
12       "paid_amount_atom": 0,
13       "remaining_amount_atom": 162000,
14       "issued_at": "2024-04-01T10:00:00Z",
15       "due_date": "2024-04-15T10:00:00Z",
16       "description": "Monthly subscription invoice for March 2024",
17       "metadata": {
18         "order_id": "ORD123456789"
19       },
20       "created_at": "2024-04-01T10:00:00Z",
21       "updated_at": "2024-04-01T10:00:00Z",
22       "applied_balance_amount_atom": 0,
23       "total_discount_amount_atom": 5000,
24       "period_start": "2024-03-01T00:00:00Z",
25       "period_end": "2024-03-31T23:59:59Z",
26       "collection_method": "charge_automatically",
27       "custom_fields": {
28         "sales_rep": "Jane Doe"
29       },
30       "items": [
31         {
32           "id": "item_4a7c9e2b3d5f6a7b",
33           "invoice_id": "inv_8f3b2c9d7a1e4b2f",
34           "description": "Monthly subscription fee for Pro Plan",
35           "quantity": 1,
36           "amount": 150000,
37           "currency": "usd",
38           "metadata": {},
39           "created_at": "2024-03-01T08:00:00Z",
40           "updated_at": "2024-03-01T08:00:00Z",
41           "price": {
42             "id": "price_1a2b3c4d5e6f7g8h",
43             "account_id": "acct_987654321",
44             "product_id": "prod_123abc456def",
45             "name": "Pro Plan Monthly",
46             "unit_amount_atom": 150000,
47             "currency": "usd",
48             "is_active": true,
49             "unit_label": "month",
50             "pricing_type": "recurring",
51             "recurring_interval": "month",
52             "recurring_interval_count": 1,
53             "auto_renew": true,
54             "contract_term_multiple": 1,
55             "trial_days": 14,
56             "usage_type": "licensed",
57             "metered_id": null,
58             "billing_scheme": "per_unit",
59             "tier_amount_info": {
60               "mode": "volume",
61               "amount_atoms": [
62                 {
63                   "unit_amount_atom": 150000,
64                   "units_upto": null,
65                   "flat_amount_atom": 0
66                 }
67               ]
68             },
69             "prerequisite_price_ids": [],
70             "exclusive_customer_ids": [],
71             "metadata": {
72               "feature_set": "all"
73             },
74             "created_at": "2023-12-01T08:00:00Z",
75             "updated_at": "2024-03-01T08:00:00Z",
76             "product_name": "Pro Plan Subscription",
77             "product_description": "Access to all premium features",
78             "custom_fields": {},
79             "quantity_divisor": 1,
80             "quantity_rounding": "ceil"
81           },
82           "product_name": "Pro Plan Subscription",
83           "proration": false,
84           "period_start": "2024-03-01T00:00:00Z",
85           "period_end": "2024-03-31T23:59:59Z",
86           "subscription_id": "sub_5d6e7f8g9h0i1j2k",
87           "subscription_item_id": "si_3f4g5h6i7j8k9l0m",
88           "tier_breakdown": [
89             {
90               "label": "March 2024 Subscription",
91               "quantity": 1,
92               "amount_atom": 150000,
93               "units_from": 1,
94               "unit_amount_atom": 150000,
95               "flat_fee": false,
96               "units_to": null
97             }
98           ]
99         }
100       ],
101       "invoice_number": 1024,
102       "billing_reason": "subscription_cycle",
103       "subscription_id": "sub_5d6e7f8g9h0i1j2k",
104       "payment_method_id": "pm_1a2b3c4d5e6f7g8h",
105       "invoice_pdf_url": "https://app.paymentkit.com/invoices/inv_8f3b2c9d7a1e4b2f.pdf",
106       "receipt_pdf_url": "https://app.paymentkit.com/receipts/rcpt_8f3b2c9d7a1e4b2f.pdf",
107       "hosted_invoice_url": "https://app.paymentkit.com/invoices/inv_8f3b2c9d7a1e4b2f",
108       "show_payment_link": true,
109       "customer_email": "customer@example.com"
110     }
111   ],
112   "total": 1,
113   "has_more": false
114 }

List invoices for an account with pagination. Works for both User and API Key authentication. Account access is automatically validated via endpoint dependency.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequired

Query parameters

limitintegerOptional1-100Defaults to 50

Number of items per page

offsetintegerOptional>=0Defaults to 0

Number of items to skip

filterstring or objectOptional

Filter conditions as a JSON string or object. All fields are optional.

customer_id (string)
subscription_id (string)
payment_intent_id (string)
status (string)
currency (string)
billing_reason (string)
total_amount_atom (integer | number | object)
created_at (string | object)
collection_method (string)
customer (string)

Filter conditions as a JSON string or object. All fields are optional. - `customer_id` (string) - `subscription_id` (string) - `payment_intent_id` (string) - `status` (string) - `currency` (string) - `billing_reason` (string) - `total_amount_atom` (integer | number | object) - `created_at` (string | object) - `collection_method` (string) - `customer` (string)

sortBystring or nullOptional

Field to sort by

sortOrderintegerOptionalDefaults to -1

Sort order: 1 for ascending, -1 for descending

searchstring or nullOptional

Keyword-based search across multiple fields

expandlist of strings or nullOptional

Fields to expand (e.g. custom_fields)

Response

Successful Response

itemslist of objects

totalinteger

has_moreboolean

Errors

422

Unprocessable Entity Error