Skip to main content
POST
Update Product

Authorizations

x-api-key
string
header
required

Merchant API Key

x-signature
string
header
required

Generated request signature

Body

application/json
productId
string
required

ID of the product to update.

referenceId
string

Your product reference ID. Can be sent instead of productId to find the product.

name
string

New product name.

description
string

New product description.

price
number

New product price. Used by billing sessions when the product has a fixed price.

currCode
string

Currency of price.

availableStock
integer

New stock count.

active
boolean

true or false to turn the product on or off. Must be the only field in the request (with productId).

deleted
boolean

true deletes the product. A deleted product can't be used in a billing session or subscription.

shippable
boolean

true for physical goods.

hsnCode
string

HSN code of the product.Required if shippable is true

userTaxId
string

ID of the new tax category.

isKycEnabled
boolean

Turns the customer KYC requirement for this product on or off.

thumbnail
string<uri>

New image URL.

images
string[]

New list of image URLs.

meta
object
shippableData
object

If shippable is true then shippable data is mandatory

Response

200 - application/json

Updated product details

quoteCurrCode
string

Currency you quoted in.

quoteAmount
number

Total after discount, in quoteCurrCode.

code
string

Merchant settlement currency.

amount
number

Total converted to the settlement currency.

totalAmount
number

Final amount to pay.

quoteAmt
number

Same as quoteAmount. Kept for backward compatibility.

tax
object

Tax breakdown: rates, amount per tax component, and total tax.

gstInclusive
boolean

Whether the amounts were calculated as tax-inclusive.

discount
object

The discount or coupon that was applied, plus amountOff in the settlement currency.

items
object[]

Your items, each with inrAmount added (line total × FX rate).

billDetails
object

The final billTo address and the same items list.