Create Invoice Item

POST

/api/:account_id/invoice-items/

POST

/api/:account_id/invoice-items/

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

1 {
2   "id": "invitem_9f8b7c6d5e4a3b2c1d0e",
3   "invoice_id": "inv_1234567890abcdef",
4   "description": "Additional storage for January 2024 billing period",
5   "quantity": 1.1,
6   "amount": 10999,
7   "currency": "usd",
8   "metadata": {},
9   "created_at": "2024-01-15T09:30:00Z",
10   "updated_at": "2024-01-15T09:30:00Z",
11   "price": {
12     "id": "price_9876543210fedcba",
13     "account_id": "acct_0011223344556677",
14     "product_id": "prod_1122334455667788",
15     "name": "Standard Plan Monthly",
16     "unit_amount_atom": 9999,
17     "currency": "usd",
18     "is_active": true,
19     "unit_label": "GB",
20     "pricing_type": "recurring",
21     "recurring_interval": "month",
22     "recurring_interval_count": 1,
23     "auto_renew": true,
24     "contract_term_multiple": 1,
25     "trial_days": 14,
26     "usage_type": "licensed",
27     "metered_id": "meter_4455667788990011",
28     "billing_scheme": "per_unit",
29     "tier_amount_info": {
30       "mode": "volume",
31       "amount_atoms": [
32         {
33           "unit_amount_atom": 9999,
34           "units_upto": 100,
35           "flat_amount_atom": 0
36         }
37       ]
38     },
39     "prerequisite_price_ids": [
40       "price_123abc456def789gh"
41     ],
42     "exclusive_customer_ids": [
43       "cust_9988776655443322"
44     ],
45     "metadata": {},
46     "created_at": "2024-01-15T09:30:00Z",
47     "updated_at": "2024-01-15T09:30:00Z",
48     "product_name": "Premium Cloud Storage",
49     "product_description": "High-speed cloud storage with 99.9% uptime SLA",
50     "custom_fields": {},
51     "quantity_divisor": 1,
52     "quantity_rounding": "ceil"
53   },
54   "product_name": "Premium Cloud Storage",
55   "proration": false,
56   "period_start": "2024-01-01T00:00:00Z",
57   "period_end": "2024-01-31T23:59:59Z",
58   "subscription_id": "sub_abcdef1234567890",
59   "subscription_item_id": "subitem_1234abcd5678efgh",
60   "tier_breakdown": [
61     {
62       "label": "Tier 1: up to 100 GB",
63       "quantity": 1.1,
64       "amount_atom": 10999,
65       "units_from": 1,
66       "unit_amount_atom": 9999,
67       "flat_fee": false,
68       "units_to": 100
69     }
70   ]
71 }

Create a floating invoice item. 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

Request

This endpoint expects an object.

namestring or nullOptional

customer_idstring or nullOptional

price_idstring or nullOptional

subscription_idstring or nullOptional

descriptionstring or nullOptional

quantitydoubleOptionalDefaults to 1

unit_amountdouble or nullOptional

amountdouble or nullOptional

metadatamap from strings to any or nullOptional

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