List Simulation Invoices

GET

/api/simulations/:external_id/invoices

GET

/api/simulations/:external_id/invoices

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

1 {
2   "items": [
3     {
4       "id": "inv_9a8b7c6d5e4f3g2h1i0j",
5       "customer_id": "cus_1234567890abcdef",
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-10T14:00:00Z",
15       "due_date": "2024-05-10T14:00:00Z",
16       "description": "Monthly subscription invoice for April 2024",
17       "metadata": {
18         "project": "Simulation Alpha",
19         "department": "Finance"
20       },
21       "created_at": "2024-04-10T14:00:00Z",
22       "updated_at": "2024-04-10T14:00:00Z",
23       "applied_balance_amount_atom": 0,
24       "total_discount_amount_atom": 5000,
25       "period_start": "2024-04-01T00:00:00Z",
26       "period_end": "2024-04-30T23:59:59Z",
27       "collection_method": "charge_automatically",
28       "custom_fields": {
29         "custom_note": "Priority customer"
30       },
31       "items": [
32         {
33           "id": "item_abcdef1234567890",
34           "invoice_id": "inv_9a8b7c6d5e4f3g2h1i0j",
35           "description": "Monthly subscription fee for Pro Plan",
36           "quantity": 1,
37           "amount": 150000,
38           "currency": "usd",
39           "metadata": {
40             "usage": "standard"
41           },
42           "created_at": "2024-04-01T00:00:00Z",
43           "updated_at": "2024-04-01T00:00:00Z",
44           "price": {
45             "id": "price_0011223344556677",
46             "account_id": "acct_9988776655443322",
47             "product_id": "prod_1122334455667788",
48             "name": "Monthly Pro Plan",
49             "unit_amount_atom": 150000,
50             "currency": "usd",
51             "is_active": true,
52             "unit_label": "month",
53             "pricing_type": "recurring",
54             "recurring_interval": "month",
55             "recurring_interval_count": 1,
56             "auto_renew": true,
57             "contract_term_multiple": 1,
58             "trial_days": 14,
59             "usage_type": "licensed",
60             "metered_id": null,
61             "billing_scheme": "per_unit",
62             "tier_amount_info": {
63               "mode": "volume",
64               "amount_atoms": [
65                 {
66                   "unit_amount_atom": 150000,
67                   "units_upto": null,
68                   "flat_amount_atom": 0
69                 }
70               ]
71             },
72             "prerequisite_price_ids": [],
73             "exclusive_customer_ids": [],
74             "metadata": {
75               "feature_set": "full"
76             },
77             "created_at": "2023-12-01T12:00:00Z",
78             "updated_at": "2024-03-01T12:00:00Z",
79             "product_name": "Pro Plan Subscription",
80             "product_description": "Access to all pro features",
81             "custom_fields": {},
82             "quantity_divisor": 1,
83             "quantity_rounding": "ceil"
84           },
85           "product_name": "Pro Plan Subscription",
86           "proration": false,
87           "period_start": "2024-04-01T00:00:00Z",
88           "period_end": "2024-04-30T23:59:59Z",
89           "subscription_id": "sub_1234abcd5678efgh",
90           "subscription_item_id": "si_9876zyxw5432vuts",
91           "tier_breakdown": [
92             {
93               "label": "Standard Rate",
94               "quantity": 1,
95               "amount_atom": 150000,
96               "units_from": 1,
97               "unit_amount_atom": 150000,
98               "flat_fee": false,
99               "units_to": null
100             }
101           ]
102         }
103       ],
104       "invoice_number": 1024,
105       "billing_reason": "subscription_cycle",
106       "subscription_id": "sub_1234abcd5678efgh",
107       "payment_method_id": "pm_abcdef1234567890",
108       "invoice_pdf_url": "https://app.paymentkit.com/invoices/inv_9a8b7c6d5e4f3g2h1i0j.pdf",
109       "receipt_pdf_url": null,
110       "hosted_invoice_url": "https://app.paymentkit.com/invoices/inv_9a8b7c6d5e4f3g2h1i0j",
111       "show_payment_link": true,
112       "customer_email": "customer@example.com"
113     }
114   ],
115   "total": 1,
116   "has_more": false
117 }

List the invoices created inside a simulation.

Powers the simulation detail page invoice view. Only invoices carrying this simulation’s id are returned (the data silo).

Authentication

AuthorizationBearer

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

Path parameters

external_idstringRequired

Query parameters

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