Get Invoice Item

GET

/api/:account_id/invoice-items/:external_id

GET

/api/:account_id/invoice-items/:external_id

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

1 {
2   "id": "invitem_8f3b2c9d7a4e",
3   "invoice_id": "inv_4a7d9e2b3c1f",
4   "description": "Monthly subscription for 100GB cloud storage",
5   "quantity": 1,
6   "amount": 9999,
7   "currency": "usd",
8   "metadata": {
9     "invoice_note": "April billing cycle"
10   },
11   "created_at": "2024-04-01T00:00:00Z",
12   "updated_at": "2024-04-10T12:00:00Z",
13   "price": {
14     "id": "price_9d8f7a6b5c4e",
15     "account_id": "acct_1234567890",
16     "product_id": "prod_9876543210",
17     "name": "100GB Storage Plan",
18     "unit_amount_atom": 9999,
19     "currency": "usd",
20     "is_active": true,
21     "unit_label": "GB",
22     "pricing_type": "recurring",
23     "recurring_interval": "month",
24     "recurring_interval_count": 1,
25     "auto_renew": true,
26     "contract_term_multiple": 1,
27     "trial_days": 14,
28     "usage_type": "licensed",
29     "metered_id": null,
30     "billing_scheme": "per_unit",
31     "tier_amount_info": {
32       "mode": "volume",
33       "amount_atoms": [
34         {
35           "unit_amount_atom": 9999,
36           "units_upto": 100,
37           "flat_amount_atom": 0
38         }
39       ]
40     },
41     "prerequisite_price_ids": [
42       "price_123abc456def"
43     ],
44     "exclusive_customer_ids": [
45       "cust_0011223344"
46     ],
47     "metadata": {
48       "region": "us-east-1",
49       "support_level": "standard"
50     },
51     "created_at": "2024-01-15T09:30:00Z",
52     "updated_at": "2024-04-10T12:00:00Z",
53     "product_name": "Premium Cloud Storage",
54     "product_description": "100GB of secure cloud storage with daily backups",
55     "custom_fields": {
56       "feature_set": "basic"
57     },
58     "quantity_divisor": 1,
59     "quantity_rounding": "ceil"
60   },
61   "product_name": "Premium Cloud Storage",
62   "proration": false,
63   "period_start": "2024-04-01T00:00:00Z",
64   "period_end": "2024-04-30T23:59:59Z",
65   "subscription_id": "sub_5f6e7d8c9b0a",
66   "subscription_item_id": "subitem_1234abcd5678",
67   "tier_breakdown": [
68     {
69       "label": "Tier 1: up to 100 GB",
70       "quantity": 1,
71       "amount_atom": 9999,
72       "units_from": 1,
73       "unit_amount_atom": 9999,
74       "flat_fee": false,
75       "units_to": 100
76     }
77   ]
78 }

Get an invoice item by ID. Returns the invoice item with its associated price and product details. 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

external_idstringRequired

account_idstringRequired

Response

Successful Response

idstring

invoice_idstring or null

descriptionstring or null

quantitydouble

amountinteger

currencystring

metadatamap from strings to any or null

created_atdatetime

updated_atdatetime

priceobject or nullOptional

product_namestring or nullOptional

prorationbooleanOptionalDefaults to false

period_startdatetime or nullOptional

period_enddatetime or nullOptional

subscription_idstring or nullOptional

subscription_item_idstring or nullOptional

tier_breakdownlist of objects or nullOptional

Errors

422

Unprocessable Entity Error