Void Invoice

POST

/api/:account_id/invoices/:external_id/void

POST

/api/:account_id/invoices/:external_id/void

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

1 {
2   "id": "inv_9f8b7c6d5e4a3b2c1d0e",
3   "customer_id": "cus_1234567890abcdef",
4   "status": "void",
5   "currency": "usd",
6   "subtotal_amount_atom": 500000,
7   "tax_amount_atom": 40000,
8   "total_amount_atom": 540000,
9   "due_amount_atom": 540000,
10   "paid_amount_atom": 0,
11   "remaining_amount_atom": 540000,
12   "issued_at": "2024-04-10T14:00:00Z",
13   "due_date": "2024-05-10T14:00:00Z",
14   "description": "Monthly subscription invoice for April 2024",
15   "metadata": {
16     "project": "website_redesign",
17     "department": "marketing"
18   },
19   "created_at": "2024-04-10T14:00:00Z",
20   "updated_at": "2024-04-10T14:05:00Z",
21   "applied_balance_amount_atom": 0,
22   "total_discount_amount_atom": 20000,
23   "period_start": "2024-04-01T00:00:00Z",
24   "period_end": "2024-04-30T23:59:59Z",
25   "collection_method": "charge_automatically",
26   "custom_fields": {
27     "custom_note": "Customer requested invoice void due to duplicate"
28   },
29   "items": [
30     {
31       "id": "item_abcdef1234567890",
32       "invoice_id": "inv_9f8b7c6d5e4a3b2c1d0e",
33       "description": "Monthly subscription fee",
34       "quantity": 1,
35       "amount": 500000,
36       "currency": "usd",
37       "metadata": {
38         "usage": "standard"
39       },
40       "created_at": "2024-04-01T00:00:00Z",
41       "updated_at": "2024-04-10T14:00:00Z",
42       "price": {
43         "id": "price_0011223344556677",
44         "account_id": "acc_9876543210fedcba",
45         "product_id": "prod_1122334455667788",
46         "name": "Pro Plan Monthly",
47         "unit_amount_atom": 500000,
48         "currency": "usd",
49         "is_active": true,
50         "unit_label": "month",
51         "pricing_type": "recurring",
52         "recurring_interval": "month",
53         "recurring_interval_count": 1,
54         "auto_renew": true,
55         "contract_term_multiple": 1,
56         "trial_days": 14,
57         "usage_type": "licensed",
58         "metered_id": null,
59         "billing_scheme": "per_unit",
60         "tier_amount_info": {
61           "mode": "volume",
62           "amount_atoms": [
63             {
64               "unit_amount_atom": 500000,
65               "units_upto": null,
66               "flat_amount_atom": 0
67             }
68           ]
69         },
70         "prerequisite_price_ids": [],
71         "exclusive_customer_ids": [],
72         "metadata": {
73           "feature_set": "all"
74         },
75         "created_at": "2023-12-01T10:00:00Z",
76         "updated_at": "2024-03-01T10:00:00Z",
77         "product_name": "Pro Plan Subscription",
78         "product_description": "Access to all pro features",
79         "custom_fields": {},
80         "quantity_divisor": 1,
81         "quantity_rounding": "ceil"
82       },
83       "product_name": "Pro Plan Subscription",
84       "proration": false,
85       "period_start": "2024-04-01T00:00:00Z",
86       "period_end": "2024-04-30T23:59:59Z",
87       "subscription_id": "sub_123abc456def789ghi",
88       "subscription_item_id": "si_987zyx654wvu321tsr",
89       "tier_breakdown": [
90         {
91           "label": "Standard Rate",
92           "quantity": 1,
93           "amount_atom": 500000,
94           "units_from": 1,
95           "unit_amount_atom": 500000,
96           "flat_fee": false,
97           "units_to": null
98         }
99       ]
100     }
101   ],
102   "invoice_number": 1024,
103   "billing_reason": "subscription_cycle",
104   "subscription_id": "sub_123abc456def789ghi",
105   "payment_method_id": "pm_456def789ghi012jkl",
106   "invoice_pdf_url": "https://app.paymentkit.com/invoices/inv_9f8b7c6d5e4a3b2c1d0e.pdf",
107   "receipt_pdf_url": null,
108   "hosted_invoice_url": "https://app.paymentkit.com/invoices/inv_9f8b7c6d5e4a3b2c1d0e",
109   "show_payment_link": false
110 }

Void an invoice.

Voiding marks the invoice as void, preventing further collection attempts. Works for invoices in DRAFT, OPEN, or PAST_DUE state.

Requirements:

Invoice must not already be PAID or VOID

Returns:

The voided invoice with VOID status

Void an invoice. Voiding marks the invoice as void, preventing further collection attempts. Works for invoices in DRAFT, OPEN, or PAST_DUE state. Requirements: - Invoice must not already be PAID or VOID Returns: - The voided invoice with VOID status

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

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

Errors

422

Unprocessable Entity Error