Items

Create and manage items using Razorpay APIs.


Items are products or services you bill customers for by adding them to an invoice.

Handy Tips
If your business requires you to create custom items, you can create pre-defined item templates beforehand and use these later as line items.

You can try out our APIs on the Razorpay Postman Public Workspace.

Run in Postman

Items Entity🔗

The Items entity has the following fields:

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. Check the list of supported currencies.
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
float 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.

You can create and manage items using APIs or from the Razorpay Dashboard.

Create an Item🔗

The following endpoint helps you create an item.

/items

Handy Tips
After an item is created, it appears on the list of created items and in the drop-down menu at the time of invoice creation.

Request Parameters🔗

name mandatory
string Name of the item.
description optional
string A brief description about the item.
amount mandatory
integer The price of the item.
currency mandatory
string The currency in which the amount should be charged. Check the list of supported currencies.

Response Parameters🔗

Descriptions for the response parameters are present in the Items Entity parameters table.

Fetch an Item🔗

The following endpoint retrieves the details of a specific item using the Item_id.

/items/:id

Path Parameter🔗

id mandatory
string The unique identifier of the item whose details are to be fetched.

Response Parameters🔗

Descriptions for the response parameters are present in the Items Entity parameters table.

Fetch Multiple Items🔗

The following endpoint retrieves the details of all the items created till date.

/items

Query Parameters🔗

from
integer Unix timestamp, in seconds, from when the items are to be fetched.
to
integer Unix timestamp, in seconds, till when the items are to be fetched.
count
integer Number of items to be fetched.
  • Default value: 10
  • Maximum value: 100
  • This can be used for pagination, in combination with the skip parameter.
skip
integer Number of records to be skipped while fetching the items.
active
integer Fetches number of active or inactive items.
  • The value is 1 for active items.
  • The value is 0 for inactive items.

Response Parameters🔗

Descriptions for the response parameters are present in the Items Entity parameters table.

Update an Item🔗

The following endpoint helps to update the details of an item.

/item/:id

Handy Tips
From the Razorpay Dashboard, you can edit the details of a created item by clicking on that specific item from the list of items.

Path Parameter🔗

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

Request Parameters🔗

name optional
string The name of the item.
description optional
string A brief description about the item.
amount optional
integer The price of the item in the lowest unit of currency.
currency optional
string The currency in which the amount should be charged. Check the list of supported currencies.
active optional
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🔗

Descriptions for the response parameters are present in the Items Entity parameters table.

Delete an Item🔗

The following endpoint helps you to delete an item.

/items/:id

Path Parameter🔗

id mandatory
string The unique identifier of the item that must be deleted.

Response Parameters🔗

Descriptions for the response parameters are present in the Items Entity parameters table.

×