Items

An Item can be a service/good that you as a merchant wish to sell to a customer. You can predefine an Item on your Razorpay Dashboard or via API, so you can quickly call them out anytime. When an item is created, it will appear on the list of items in the Dashboard.

Tip:
If your business requires you to create custom items, you can create many pre-defined item template at the ready so you can use later as a line item.

Items Entity#

Following is a list of attributes of an item entity and their explanation:

id string: Mandatory. Unique Id of the item
name string: Mandatory. Name of the item
description string: Optional. A text description about the item
amount integer: Mandatory. Expected to be in paise format
currency string in: INR: Mandatory. Currency of the item. Select from the list of currencies here.

active boolean string :Mandatory

 Sample Entity
Copy{
  "id": "item_7Oxp4hmm6T4SCn",
  "active": true,
  "name": "Book / English August",
  "description": "An indian story, Booker prize winner.",
  "amount": 20000,
  "currency": "INR"
}

Create an Item#

The Items API allows you create an item and perform other operation corresponding to that item.

/items

 Input Response
Copy{
  "name": "Book / English August",
  "description": "An indian story, Booker prize winner.",
  "amount": 20000,
  "currency": "INR"
}
Copy{
  "id": "item_7Oxp4hmm6T4SCn",
  "active": true,
  "name": "Book / English August",
  "description": "An indian story, Booker prize winner.",
  "amount": 20000,
  "currency": "INR"
}

Once an item is created, it will appear on the list of created item and also in the drop-down menu at the time of invoice creation. You can also edit the details of a created customer by going to the list of customers and clicking on edit under Actions.

Fetch an Item#

/items/:id

The response for getting an item id: item_7Oxp4hmm6T4SCn is shown below:

 Response
Copy{
  "id": "item_7Oxp4hmm6T4SCn",
  "active": true,
  "name": "Book / English August",
  "description": "An indian story, Booker prize winner.",
  "amount": 20000,
  "currency": "INR"
}

Fetch Multiple Items#

/items

 Response
Copy{
  "entity": "collection",
  "count": 3,
  "items": [
    {
      "id": "item_7Oy8OMV6BdEAac",
      "active": true,
      "name": "Book / Ignited Minds",
      "description": null,
      "amount": 15000,
      "currency": "INR"
    },
    {
      "id": "item_7Oxp4hmm6T4SCn",
      "active": true,
      "name": "Book / English August",
      "description": "An indian story, Booker prize winner.",
      "amount": 20000,
      "currency": "INR"
    },
    {
      "id": "item_7OxoGnoxCuUKbo",
      "active": true,
      "name": "Book / English August",
      "description": null,
      "amount": 20000,
      "currency": "INR"
    }
  ]
}

Update an Item#

/item/:id

The response for getting an item id: item_7Oy8OMV6BdEAac is shown below:

 Input #1 Response #1 Input #2 Response #2
Copy{
  "name": "Book / Ignited Minds - Updated name!",
  "description": "New descirption too. :)"
}
Copy{
  "id": "item_7Oy8OMV6BdEAac",
  "active": true,
  "name": "Book / Ignited Minds - Updated name!",
  "description": "New descirption too. :)",
  "amount": 15000,
  "currency": "INR"
}
Copy{
  "active": "0"
}
Copy{
  "id": "item_7Oy8OMV6BdEAac",
  "active": false,
  "name": "Book / Ignited Minds - Updated name!",
  "description": "New descirption too. :)",
  "amount": 15000,
  "currency": "INR"
}

Delete an Item#

/items/:id

The response for deleting an item id: item_7Oy8OMV6BdEAac is shown below:

 Response
Copy[]