Get Invoice

GET

/api/:account_id/invoices/:external_id

GET

/api/:account_id/invoices/:external_id

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

1 {
2   "id": "inv_8f3b2c9d7a1e4b6f",
3   "customer_id": "cus_4a7d9e2f1b3c5d6e",
4   "status": "open",
5   "currency": "usd",
6   "subtotal_amount_atom": 150000,
7   "tax_amount_atom": 12000,
8   "total_amount_atom": 162000,
9   "due_amount_atom": 162000,
10   "paid_amount_atom": 0,
11   "remaining_amount_atom": 162000,
12   "issued_at": "2024-01-15T09:30:00Z",
13   "due_date": "2024-02-14T23:59:59Z",
14   "description": "Monthly subscription invoice for January 2024",
15   "metadata": {
16     "order_id": "ORD-20240115-001"
17   },
18   "created_at": "2024-01-15T09:30:00Z",
19   "updated_at": "2024-01-15T09:30:00Z",
20   "applied_balance_amount_atom": 0,
21   "total_discount_amount_atom": 10000,
22   "period_start": "2024-01-01T00:00:00Z",
23   "period_end": "2024-01-31T23:59:59Z",
24   "collection_method": "charge_automatically",
25   "custom_fields": {
26     "sales_rep": "Jane Doe"
27   },
28   "items": [
29     {
30       "id": "item_9c8d7e6f5a4b3c2d",
31       "invoice_id": "inv_8f3b2c9d7a1e4b6f",
32       "description": "Monthly subscription fee",
33       "quantity": 1,
34       "amount": 150000,
35       "currency": "usd",
36       "metadata": {
37         "line_item_note": "Standard monthly charge"
38       },
39       "created_at": "2024-01-01T00:00:00Z",
40       "updated_at": "2024-01-15T09:00:00Z",
41       "price": {
42         "id": "price_123abc456def",
43         "account_id": "acct_789xyz123uvw",
44         "product_id": "prod_456def789abc",
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": "full"
73         },
74         "created_at": "2023-12-01T12:00:00Z",
75         "updated_at": "2024-01-10T08:00:00Z",
76         "product_name": "Pro Plan Subscription",
77         "product_description": "Access to all Pro features",
78         "custom_fields": {
79           "support_level": "priority"
80         },
81         "quantity_divisor": 1,
82         "quantity_rounding": "ceil"
83       },
84       "product_name": "Pro Plan Subscription",
85       "proration": false,
86       "period_start": "2024-01-01T00:00:00Z",
87       "period_end": "2024-01-31T23:59:59Z",
88       "subscription_id": "sub_7e6f5a4b3c2d1e0f",
89       "subscription_item_id": "si_1a2b3c4d5e6f7g8h",
90       "tier_breakdown": [
91         {
92           "label": "Base rate",
93           "quantity": 1,
94           "amount_atom": 150000,
95           "units_from": 1,
96           "unit_amount_atom": 150000,
97           "flat_fee": false,
98           "units_to": null
99         }
100       ]
101     }
102   ],
103   "invoice_number": 1024,
104   "billing_reason": "subscription_cycle",
105   "subscription_id": "sub_7e6f5a4b3c2d1e0f",
106   "payment_method_id": "pm_4a7d9e2f1b3c5d6e",
107   "invoice_pdf_url": "https://app.paymentkit.com/invoices/inv_8f3b2c9d7a1e4b6f.pdf",
108   "receipt_pdf_url": null,
109   "hosted_invoice_url": "https://app.paymentkit.com/invoices/inv_8f3b2c9d7a1e4b6f",
110   "show_payment_link": true,
111   "customer_email": "customer@example.com",
112   "default_payment_method": {
113     "id": "pm_4a7d9e2f1b3c5d6e",
114     "account_id": "acct_789xyz123uvw",
115     "customer_id": "cus_4a7d9e2f1b3c5d6e",
116     "provider_type": "credit_card",
117     "name": "Visa ending in 4242",
118     "is_active": true,
119     "metadata": {
120       "last4": "4242",
121       "brand": "Visa",
122       "exp_month": 12,
123       "exp_year": 2025,
124       "bin": "411111",
125       "card_attributes": {
126         "card_type": "CREDIT",
127         "card_segment_type": "CONSUMER",
128         "prepaid_card": "NO",
129         "virtual_card": "NO",
130         "country_name": "United States",
131         "country_numeric": "840",
132         "regulated": "YES"
133       }
134     },
135     "created_at": "2023-11-20T14:00:00Z",
136     "updated_at": "2024-01-10T08:00:00Z",
137     "used_in_subscription": true,
138     "network_token_status": null
139   },
140   "payment_method": {
141     "id": "pm_4a7d9e2f1b3c5d6e",
142     "account_id": "acct_789xyz123uvw",
143     "customer_id": "cus_4a7d9e2f1b3c5d6e",
144     "provider_type": "credit_card",
145     "name": "Visa ending in 4242",
146     "is_active": true,
147     "metadata": {
148       "last4": "4242",
149       "brand": "Visa",
150       "exp_month": 12,
151       "exp_year": 2025,
152       "bin": "411111",
153       "card_attributes": {
154         "card_type": "CREDIT",
155         "card_segment_type": "CONSUMER",
156         "prepaid_card": "NO",
157         "virtual_card": "NO",
158         "country_name": "United States",
159         "country_numeric": "840",
160         "regulated": "YES"
161       }
162     },
163     "created_at": "2023-11-20T14:00:00Z",
164     "updated_at": "2024-01-10T08:00:00Z",
165     "used_in_subscription": true,
166     "network_token_status": null
167   },
168   "discounts": [
169     {
170       "id": "disc_1a2b3c4d5e6f7g8h",
171       "coupon_id": "cpn_9f8e7d6c5b4a3f2e",
172       "promotion_code_id": "promo_123abc456def",
173       "attachment_level": "invoice",
174       "customer_id": "cus_4a7d9e2f1b3c5d6e",
175       "subscription_id": "sub_7e6f5a4b3c2d1e0f",
176       "invoice_id": "inv_8f3b2c9d7a1e4b6f",
177       "invoice_item_id": null,
178       "start_date": "2024-01-01T00:00:00Z",
179       "end_date": "2024-01-31T23:59:59Z",
180       "is_active": true,
181       "metadata": {
182         "description": "New Year Discount"
183       },
184       "created_at": "2023-12-15T10:00:00Z",
185       "updated_at": "2024-01-15T09:00:00Z"
186     }
187   ],
188   "payments": [
189     {
190       "payment_intent_id": "pi_1a2b3c4d5e6f7g8h9",
191       "amount_atom": 162000,
192       "total_amount_atom": 162000,
193       "refunded_amount_atom": 0,
194       "status": "pending",
195       "created_at": "2024-01-15T09:35:00Z",
196       "processor_attempt_id": "proc_987zyx654wvu321",
197       "decline_reason": null,
198       "failure_code": null
199     }
200   ],
201   "last_payment_error": null
202 }

Get an invoice by ID. 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

Query parameters

expandlist of strings or nullOptional

Response

Successful Response

idstring

customer_idstring

statusenum

currencyenum

ISO 4217 currency codes.

subtotal_amount_atominteger or null

tax_amount_atominteger or null

total_amount_atominteger or null

due_amount_atominteger or null

paid_amount_atominteger or null

remaining_amount_atominteger or null

issued_atdatetime

due_datedatetime or null

descriptionstring or null

metadatamap from strings to any or null

created_atdatetime

updated_atdatetime

applied_balance_amount_atominteger or nullOptional

total_discount_amount_atominteger or nullOptional

period_startdatetime or nullOptional

period_enddatetime or nullOptional

collection_methodenumOptional

custom_fieldsmap from strings to any or nullOptional

Custom field values. Only included when expand=custom_fields is specified.

itemslist of objectsOptional

invoice_numberinteger or nullOptional

billing_reasonenum or nullOptional

subscription_idstring or nullOptional

payment_method_idstring or nullOptional

invoice_pdf_urlstring or nullOptional

receipt_pdf_urlstring or nullOptional

hosted_invoice_urlstring or nullOptional

show_payment_linkbooleanOptionalDefaults to false

customer_emailstring or nullOptional

default_payment_methodobject or nullOptional

Payment method API response model.

payment_methodobject or nullOptional

Payment method API response model.

discountslist of objectsOptional

paymentslist of objectsOptional

last_payment_errorstring or nullOptional

Errors

422

Unprocessable Entity Error