Skip to main content
PUT
/
v1
/
sdk
/
products
/
{productRef}
Update a product
curl --request PUT \
  --url https://api.example.com/v1/sdk/products/{productRef} \
  --header 'Content-Type: application/json' \
  --data '
{
  "config": {},
  "description": "<string>",
  "imageUrl": "<string>",
  "metadata": {},
  "name": "<string>",
  "productType": "<string>",
  "status": "active"
}
'
{
  "balance": 0,
  "createdAt": "<string>",
  "id": "507f1f77bcf86cd799439011",
  "isMcpPay": false,
  "name": "AI Writing Assistant",
  "reference": "prd_1A2B3C4D",
  "status": "active",
  "totalTransactions": 0,
  "updatedAt": "<string>",
  "config": {},
  "description": "<string>",
  "imageUrl": "<string>",
  "metadata": {},
  "plans": [
    "<string>"
  ],
  "productType": "<string>"
}

Path Parameters

productRef
string
required

Product reference or ID

Example:

"prd_1A2B3C4D"

Body

application/json
config
object

Product-specific configuration

description
string

Product description

imageUrl
string

URL to the product image

metadata
object

Arbitrary key-value metadata

name
string

Product name

productType
string

Free-form product type defined by the provider

status
enum<string>

Product status

Available options:
active,
inactive,
suspended

Response

Product updated successfully

balance
number
required

Product balance in cents

Example:

0

createdAt
string
required

Creation timestamp

id
string
required

Product ID

Example:

"507f1f77bcf86cd799439011"

isMcpPay
boolean
required

Whether this product uses MCP Pay proxy

Example:

false

name
string
required

Product name

Example:

"AI Writing Assistant"

reference
string
required

Product reference

Example:

"prd_1A2B3C4D"

status
string
required

Product status

Example:

"active"

totalTransactions
number
required

Total number of transactions

Example:

0

updatedAt
string
required

Last update timestamp

config
object

Product-specific configuration

description
string

Product description

imageUrl
string

URL to the product image

metadata
object

Arbitrary key-value metadata

plans
string[]

Plans associated with this product

productType
string

Free-form product type