> ## Documentation Index
> Fetch the complete documentation index at: https://razorpay-881012b3.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Cancel an Invoice
> Cancel an invoice using this endpoint.
Available in
🇮🇳 India
🇸🇬 Singapore
🇺🇸 United States
Use this endpoint to cancel an invoice. Invoices in the `paid` state cannot be cancelled.
```bash Curl theme={null}
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
-X POST https://api.razorpay.com/v1/invoices/inv_JqVZyyKWjCs9cY/cancel \
```
```java Java theme={null}
RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");
String invoiceId = "inv_DC2XAh2fOFuU15";
Invoice invoice = razorpay.invoices.cancel(invoiceId);
```
```python Python theme={null}
import razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))
client.invoice.cancel(invoiceId)
```
```ruby Ruby theme={null}
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')
Razorpay::Invoice.cancel(invoiceId)
```
```php PHP theme={null}
$api = new Api($key_id, $secret);
$api->invoice->fetch($invoiceId)->cancel();
```
```go Go theme={null}
import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")
body, err := client.Invoice.Cancel("", nil, nil)
```
```javascript Node.js theme={null}
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })
instance.invoices.cancel(invoiceId)
```
```csharp .NET theme={null}
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]
");
string invoiceId = "inv_DAweOiQ7amIUVd";
Invoice invoice = client.Invoice.Fetch(invoiceId).Cancel();
```
```bash CLI theme={null}
razorpay invoices cancel inv_ABC123
```
```json Success theme={null}
{
"amount": 20000,
"amount_due": null,
"amount_paid": null,
"billing_end": null,
"billing_start": null,
"cancelled_at": 1657203958,
"comment": "Fresh sea weed mowed this morning",
"created_at": 1657203943,
"currency": "SGD",
"currency_symbol": "",
"customer_details": {
"billing_address": null,
"contact": "",
"customer_contact": "",
"customer_email": "",
"customer_name": "",
"email": "",
"gstin": null,
"id": "cust_DtHaBuooGHTuyZ",
"name": "",
"shipping_address": null
},
"customer_id": "cust_DtHaBuooGHTuyZ",
"date": 1588076279,
"description": "Domestic invoice for Gaurav Kumar.",
"email_status": "pending",
"entity": "invoice",
"expire_by": 1924991999,
"expired_at": null,
"first_payment_min_amount": null,
"gross_amount": 20000,
"group_taxes_discounts": false,
"id": "inv_JqVZyyKWjCs9cY",
"idempotency_key": null,
"invoice_number": "Receipt No. 123234",
"issued_at": null,
"line_items": [
{
"amount": 20000,
"currency": "SGD",
"description": "Crate of sea weed.",
"gross_amount": 20000,
"hsn_code": null,
"id": "li_JqVZyzHIx1exXC",
"item_id": null,
"name": "Crate of sea weed",
"net_amount": 20000,
"quantity": 1,
"ref_id": null,
"ref_type": null,
"sac_code": null,
"tax_amount": 0,
"tax_inclusive": false,
"tax_rate": null,
"taxable_amount": 20000,
"taxes": [],
"type": "invoice",
"unit": null,
"unit_amount": 20000
}
],
"notes": {
"notes_key_1": "Tea, Earl Grey, Hot",
"notes_key_2": "Tea, Earl Grey… decaf."
},
"order_id": null,
"paid_at": null,
"partial_payment": true,
"payment_id": null,
"receipt": "Receipt No. 123234",
"reminder_status": null,
"short_url": null,
"sms_status": "pending",
"status": "cancelled",
"subscription_status": null,
"supply_state_code": null,
"tax_amount": 0,
"taxable_amount": 20000,
"terms": "No Returns; No Refunds",
"type": "invoice",
"user_id": null,
"view_less": true
}
```
```json Failure theme={null}
{
"error": {
"code": "BAD_REQUEST_ERROR",
"description": "Operation not allowed for Invoice in cancelled status.",
"source": "business",
"step": "payment_initiation",
"reason": "input_validation_failed",
"metadata": {}
}
}
```
## Path Parameters
The unique identifier of the invoice.
## Response Parameters
The unique identifier of the invoice.
Indicates the type of entity. Here, it is `invoice`.
Here, it should be `invoice`.
Unique number you added for internal reference. The minimum character length is 1 and maximum is 40.
The unique identifier of the customer. You can create `customer_id` using the [Customers API](/docs/sg/api/customers). Alternatively, you can pass the customer object described in the below fields.
Details of the customer.
Unique identifier of the customer. For example, `cust_1Aa00000000004`.
Customer's name. Alphanumeric, with period (.), apostrophe (') and parentheses allowed. The name must be between 3-50 characters in length. For example, `Gaurav Kumar`.
The customer's email address. A maximum length of 64 characters. For example, `gaurav.kumar@example.com`.
The customer's phone number. A maximum length of 15 characters including country code. For example, `+919876543210`.
Details of the customer's billing address.
The unique identifier generated for the customer's billing address.
The customer address type. Here it is `billing_address`.
Defines if this is the primary address.
* `true`: It is the customer's primary address.
* `false`: It is not the customer's primary address.
The first line of the customer's address.
The second line of the customer's address.
The city.
The zipcode.
The state.
The country.
Details of the customer's shipping address.
The unique identifier generated for the customer's shipping address.
The customer address type. Here it is `shipping_address`.
Defines if this is the primary address.
* `true`: It is the customer's primary address.
* `false`: It is not the customer's primary address.
The first line of the customer's address.
The second line of the customer's address.
The city.
The zipcode.
The state.
The country.
The unique identifier of the order associated with the invoice.
Details of the line item that is billed in the invoice. Maximum of 50 line items.
Unique identifier that is generated if a new item has been created while creating the invoice.
Unique identifier of the item generated using Items API that has been billed in the invoice.
The item's name.
A brief description of the item.
The price of the item.
The currency associated with the item. Default is `INR`. Know about the [list of supported international currencies](/docs/sg/payments/international-payments#supported-currencies).
Here, it is `invoice`.
The quantity of the item billed in the invoice. Defaults to `1`.
Unique identifier of a payment made against this invoice.
The status of the invoice. Know more about [Invoice States](/docs/sg/payments/invoices/states). Possible values:
* `draft`
* `issued`
* `partially_paid`
* `paid`
* `cancelled`
* `expired`
* `deleted`
Timestamp, in Unix format, at which the invoice will expire.
Timestamp, in Unix format, at which the invoice was issued to the customer.
Timestamp, in Unix format, at which the payment was made.
Timestamp, in Unix format, at which the invoice was cancelled.
Timestamp, in Unix format, at which the invoice expired.
The delivery status of the SMS notification for the invoice sent to the customer. Possible values:
* `pending`
* `sent`
The delivery status of the email notification for the invoice sent to the customer. Possible values:
* `pending`
* `sent`
Indicates whether the customer can make a partial payment on the invoice. Possible values:
* `true`: The customer can make partial payments.
* `false` (default): The customer cannot make partial payments.
Amount to be paid using the invoice. Must be in the smallest unit of the currency. For example, if the amount to be received from the customer is , pass the value as `30000`.
Amount paid by the customer against the invoice.
The remaining amount to be paid by the customer for the issued invoice.
The currency associated with the invoice. You must mandatorily pass this parameter if accepting international payments. If you have passed `currency` as a sub-parameter in the `line_item` object, you must ensure that the same currency is passed in both places. Know about the [list of supported international currencies.](/docs/sg/payments/international-payments#supported-currencies)
A brief description of the invoice. The maximum character length is 2048.
Any custom notes added to the invoice. Maximum of 2048 characters.
The short URL that is generated. Share this link with customers to accept payments.
Timestamp, in Unix format, that indicates the issue date of the invoice.
Any terms to be included in the invoice. Maximum of 2048 characters.
Any comments to be added in the invoice. Maximum of 2048 characters.
A unique reference number for the invoice, used for internal tracking and reconciliation.
Unique identifier of the user associated with this invoice.
The first payment min amount for this invoice, in the smallest currency unit (paise for INR).
A unique receipt number that you can provide for the invoice, for your internal reference.
For example, `₹`.
A unique key used to ensure idempotency of the invoice creation request, preventing duplicate invoices.
Unique identifier of the subscription this invoice was generated for. `null` for one-off invoices.
## Errors
**Code:** `400`
Cancellation is only allowed on invoices in the `draft` or `issued` state. The error message echoes the invoice's actual current status. For example, `Operation not allowed for Invoice in paid status.` if the invoice has already been paid.
**Solution:** Verify the invoice's current status using the Fetch Invoice API. Only invoices in `draft` or `issued` state can be cancelled.
**Code:** `400`
The invoice was in the `issued` state at the time of the cancel request but a payment was already in progress against it.
**Solution:** Fetch the invoice and confirm its current state. Once the payment finalises, the invoice will move to `paid` or `partially_paid` and can no longer be cancelled.
**Code:** `4xx`
The API credentials passed in the API call differ from the ones generated on the Dashboard.
**Solution:** The API keys must be active and entered correctly with no whitespace before or after.
**Code:** `400`
The invoice id passed in the URL does not exist or does not belong to the requesting merchant.
**Solution:** Use a valid invoice id returned from `POST /v1/invoices`. Confirm by fetching the invoice before retrying.