API Test Keys

Update an Item

PATCH

/v1/items/:id

Click to copy

Use this endpoint to update the details of an item. From the Curlec Dashboard, you can edit the details of a created item by clicking on that specific item from the list of items.

Is this page helpful?

Curl

change language

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2  -H "Content-Type: application/json" \
3  -X PATCH https://api.razorpay.com/v1/items/item_7Oy8OMV6BdEAac \
4  -d '{
5        "name":"Book / Ignited Minds - Updated name!",
6        "description":"New descirption too."
7      }'

Success

Failure

1{
2  "id": "item_7Oy8OMV6BdEAac",
3  "active": true,
4  "name": "Book / Ignited Minds - Updated name!",
5  "description": "New descirption too.",
6  "amount": 20000,
7  "unit_amount": 20000,
8  "currency": "MYR",
9  "type": "invoice",
10  "unit": null,
11  "tax_inclusive": false,
12  "hsn_code": null,
13  "sac_code": null,
14  "tax_rate": null,
15  "tax_id": null,
16  "tax_group_id": null,
17  "created_at": 1649843796
18}

Path Parameters

id

string

The unique identifer of the item whose details are to be updated.

Request Parameters

name

string

The name of the item.

description

string

A brief description about the item.

amount

integer

The price of the item in the lowest unit of currency.

currency

string

The currency in which the amount should be charged.

active

boolean

Indicates the status of the item. Possible values:

true (default): Item is in the active state.
false: Item is in the inactive state.

Response Parameters

id

string

The unique identifier of the item.

active

boolean

Indicates the status of the item. Possible values:

true (default): Item is in the active state.
false: Item is in the inactive state.

name

string

The name of the item.

description

string

A text description about the item.

amount

integer

The price of the item.

unit_amount

integer

The per unit billing amount for each individual unit.

currency

string

The currency in which the amount should be charged.

type

string

Here, it must be invoice.

unit

integer

The number of units of the item billed in the invoice.

tax_inclusive

boolean

Indicates whether the base amount includes tax.

true: The base amount includes tax.
false: The base amount does not include tax. By default, the value is set to false.

hsn_code

integer

The 8-digit code used to classify the product as per the Harmonised System of Nomenclature.

sac_code

integer

The 6-digit code used to classify the service as per the Services Accounting Code.

tax_rate

string

The percentage at which an individual or a corporation is taxed.

tax_id

string

The identification number that gets displayed on invoices issued to the customer.

tax_group_id

string

The identification number for the tax group. A tax group is a collection of taxes that can be applied as a single set of rules.

created_at

integer

Unix timestamp, at which the item was created. For example, 1649843796.

Errors

The API <key/secret> provided is invalid.

Error Status: 4xx

The API key or secret are not entered or an invalid API key is used.

Solution

The id provided does not exist.

Error Status: 400

The invoice id entered is either invalid or does not belong to the requester account.

Solution

The amount field is required when item id is not present.

Error Status: 400

Only name is entered without item id or amount.

Solution

The name field is required when item id is not present.

Error Status: 400

Possible reasons:

Only the amount field is entered without a name or item id.
The amount, name or item id are not entered.

Solution

Update an Item

PATCH

/v1/items/:id

Click to copy

Use this endpoint to update the details of an item. From the Curlec Dashboard, you can edit the details of a created item by clicking on that specific item from the list of items.

Is this page helpful?

Path Parameters

id

string

The unique identifer of the item whose details are to be updated.

Request Parameters

name

string

The name of the item.

description

string

A brief description about the item.

amount

integer

The price of the item in the lowest unit of currency.

currency

string

The currency in which the amount should be charged.

active

boolean

Indicates the status of the item. Possible values:

true (default): Item is in the active state.
false: Item is in the inactive state.

Response Parameters

id

string

The unique identifier of the item.

active

boolean

Indicates the status of the item. Possible values:

true (default): Item is in the active state.
false: Item is in the inactive state.

name

string

The name of the item.

description

string

A text description about the item.

amount

integer

The price of the item.

unit_amount

integer

The per unit billing amount for each individual unit.

currency

string

The currency in which the amount should be charged.

type

string

Here, it must be invoice.

unit

integer

The number of units of the item billed in the invoice.

tax_inclusive

boolean

Indicates whether the base amount includes tax.

true: The base amount includes tax.
false: The base amount does not include tax. By default, the value is set to false.

hsn_code

integer

The 8-digit code used to classify the product as per the Harmonised System of Nomenclature.

sac_code

integer

The 6-digit code used to classify the service as per the Services Accounting Code.

tax_rate

string

The percentage at which an individual or a corporation is taxed.

tax_id

string

The identification number that gets displayed on invoices issued to the customer.

tax_group_id

string

The identification number for the tax group. A tax group is a collection of taxes that can be applied as a single set of rules.

created_at

integer

Unix timestamp, at which the item was created. For example, 1649843796.

Errors

The API <key/secret> provided is invalid.

Error Status: 4xx

The API key or secret are not entered or an invalid API key is used.

Solution

The id provided does not exist.

Error Status: 400

The invoice id entered is either invalid or does not belong to the requester account.

Solution

The amount field is required when item id is not present.

Error Status: 400

Only name is entered without item id or amount.

Solution

The name field is required when item id is not present.

Error Status: 400

Possible reasons:

Only the amount field is entered without a name or item id.
The amount, name or item id are not entered.

Solution

Curl

change language

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2  -H "Content-Type: application/json" \
3  -X PATCH https://api.razorpay.com/v1/items/item_7Oy8OMV6BdEAac \
4  -d '{
5        "name":"Book / Ignited Minds - Updated name!",
6        "description":"New descirption too."
7      }'

Success

Failure

1{
2  "id": "item_7Oy8OMV6BdEAac",
3  "active": true,
4  "name": "Book / Ignited Minds - Updated name!",
5  "description": "New descirption too.",
6  "amount": 20000,
7  "unit_amount": 20000,
8  "currency": "MYR",
9  "type": "invoice",
10  "unit": null,
11  "tax_inclusive": false,
12  "hsn_code": null,
13  "sac_code": null,
14  "tax_rate": null,
15  "tax_id": null,
16  "tax_group_id": null,
17  "created_at": 1649843796
18}