List Invoice Items

GET

/api/:account_id/invoice-items/

GET

/api/:account_id/invoice-items/

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

1 {
2   "items": [
3     {
4       "id": "invitem_8f3b2c9d",
5       "invoice_id": "inv_4a7d9e2b",
6       "description": "Charge for 110 SMS messages sent in March 2024",
7       "quantity": 110,
8       "amount": 550000,
9       "currency": "usd",
10       "metadata": {
11         "campaign": "spring_sale",
12         "region": "us-east-1"
13       },
14       "created_at": "2024-04-01T10:00:00Z",
15       "updated_at": "2024-04-10T12:00:00Z",
16       "price": {
17         "id": "price_9c8d7e6f",
18         "account_id": "acct_1234567890",
19         "product_id": "prod_5f4e3d2c",
20         "name": "SMS Premium Plan",
21         "unit_amount_atom": 5000,
22         "currency": "usd",
23         "is_active": true,
24         "unit_label": "message",
25         "pricing_type": "recurring",
26         "recurring_interval": "month",
27         "recurring_interval_count": 1,
28         "auto_renew": true,
29         "contract_term_multiple": 1,
30         "trial_days": 14,
31         "usage_type": "licensed",
32         "metered_id": null,
33         "billing_scheme": "per_unit",
34         "tier_amount_info": {
35           "mode": "volume",
36           "amount_atoms": [
37             {
38               "unit_amount_atom": 5000,
39               "units_upto": 1000,
40               "flat_amount_atom": 0
41             },
42             {
43               "unit_amount_atom": 4500,
44               "units_upto": null,
45               "flat_amount_atom": 0
46             }
47           ]
48         },
49         "prerequisite_price_ids": [
50           "price_7a6b5c4d"
51         ],
52         "exclusive_customer_ids": [
53           "cus_9876543210"
54         ],
55         "metadata": {
56           "region": "us-east-1",
57           "support_level": "gold"
58         },
59         "created_at": "2024-01-15T09:30:00Z",
60         "updated_at": "2024-04-10T12:00:00Z",
61         "product_name": "Premium SMS Package",
62         "product_description": "Monthly subscription for premium SMS messaging",
63         "custom_fields": {
64           "custom_note": "Includes priority support"
65         },
66         "quantity_divisor": 1,
67         "quantity_rounding": "ceil"
68       },
69       "product_name": "Premium SMS Package",
70       "proration": false,
71       "period_start": "2024-03-01T00:00:00Z",
72       "period_end": "2024-03-31T23:59:59Z",
73       "subscription_id": "sub_3e2f1d0c",
74       "subscription_item_id": "subitem_1a2b3c4d",
75       "tier_breakdown": [
76         {
77           "label": "1-1000 messages",
78           "quantity": 110,
79           "amount_atom": 550000,
80           "units_from": 1,
81           "unit_amount_atom": 5000,
82           "flat_fee": false,
83           "units_to": 1000
84         }
85       ]
86     }
87   ],
88   "total": 1,
89   "has_more": false
90 }

List invoice items for an account with pagination.

Surfaces floating/pending invoice items (e.g. usage charges not yet swept into a renewal invoice) that were previously only reachable by their id. Works for both User and API Key authentication; account access is validated by the endpoint dependency.

Authentication

AuthorizationBearer

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

Path parameters

account_idstringRequired

Query parameters

customer_idstring or nullOptional

Filter by customer ID (cus_…).

subscription_idstring or nullOptional

Filter by subscription ID (sub_…).

statusenum or nullOptional

Filter by attachment state: ‘floating’ (unbilled, invoice_id is null) or ‘attached’ (swept onto an invoice).

Allowed values:

limitintegerOptional1-100Defaults to 50

Number of items per page

offsetintegerOptional>=0Defaults to 0

Number of items to skip

filterstringOptionalDefaults to {}

Filter conditions as key-value pairs or advanced filter objects (JSON 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

Response

Successful Response

itemslist of objects

totalinteger

has_moreboolean

Errors

422

Unprocessable Entity Error