Introduction

API Reference Guide

API Changelog

API Basics

Authentication & Sandbox Setup

Entity & Metadata

Pagination & Rate Limiting

Best Practices

Glossary

Payments

Orders

Payments

Downtime

Settlements

Instant Settlements

Refunds

Disputes

Documents

Customers

Payment Links

QR Codes

Invoices

Items

Plans

Subscriptions

Add-on

Linked Account

Stakeholder

Product Configuration

Transfers

Smart Collect

Smart Collect With TPV

Bills

About Bills

Bills Entity

Create a Bill

Update a Bill

Delete a Bill

Partners

Account

Product Configuration

Stakeholder

Terms and Conditions

Documents

Webhooks

Payout APIs

Get Started

Account Validation

Composite Account Validation

Contacts

Fund Accounts

Payouts

Payouts to Cards

Payout Composite

Payouts Approval

Payout Idempotency

Payout Links

Payout Wallet - Amazon

Transactions

Api

Payments

Items

Fetch With Id

API Test Keys

Fetch Item With ID

GET
/v1/items/:id

Click to copy

Use this endpoint to retrieve the details of a specific item using the Item_id.

Is this page helpful?

Curl

change language

change language

1
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2
  - X GET https://api.razorpay.com/v1/items/item_7Oxp4hmm6T4SCn \

Success

1
{
2
  "id": "item_7Oxp4hmm6T4SCn",
3
  "active": true,
4
  "name": "Book / English August",
5
  "description": "A Malaysian story, Booker prize winner.",
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 identifier of the item whose details are to be fetched.

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 active state.
  • false: Item is in 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.

Fetch Item With ID

GET
/v1/items/:id

Click to copy

Use this endpoint to retrieve the details of a specific item using the Item_id.

Is this page helpful?

Path Parameters
id

*

string

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

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 active state.
  • false: Item is in 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.

Curl

change language

change language

1
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2
  - X GET https://api.razorpay.com/v1/items/item_7Oxp4hmm6T4SCn \

Success

1
{
2
  "id": "item_7Oxp4hmm6T4SCn",
3
  "active": true,
4
  "name": "Book / English August",
5
  "description": "A Malaysian story, Booker prize winner.",
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
}