Skip to main content
PATCH
/
products
/
{product_id}
Update a product
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'AeroEdit for learner pilots'})
};

fetch('https://api.paddle.com/products/{product_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": {
    "id": "pro_01htz88xpr0mm7b3ta2pjkr7w2",
    "name": "AeroEdit for learner pilots",
    "tax_category": "standard",
    "type": "standard",
    "description": "Essential tools for student pilots to manage flight logs, analyze performance, and plan routes, and ensure compliance. Valid student pilot certificate from the FAA required.",
    "image_url": "https://paddle.s3.amazonaws.com/user/165798/bT1XUOJAQhOUxGs83cbk_pro.png",
    "custom_data": {
      "features": {
        "aircraft_performance": true,
        "compliance_monitoring": false,
        "flight_log_management": true,
        "payment_by_invoice": false,
        "route_planning": true,
        "sso": false
      },
      "suggested_addons": [
        "pro_01h1vjes1y163xfj1rh1tkfb65",
        "pro_01gsz97mq9pa4fkyy0wqenepkz"
      ],
      "upgrade_description": null
    },
    "status": "active",
    "import_meta": null,
    "created_at": "2024-04-08T16:22:16.024Z",
    "updated_at": "2024-04-08T16:27:59.074Z"
  },
  "meta": {
    "request_id": "6e0077bb-9f36-465c-a303-eaaf9d4d44aa"
  }
}

Authorizations

Authorization
string
header
required

Requests are authenticated with API keys. Provide your API key as a Bearer token in the Authorization header.

API keys are assigned permissions, granting them access to entities and operations. Each endpoint may require one or more permissions, defined with the x-permissions extension. Values for include parameters may require specific permissions as defined in the x-enum-permissions extension. See all available permissions in the permission schema or documentation.

Get an API key and select the permissions you need from the Paddle dashboard under Paddle > Developer Tools > Authentication.

Path Parameters

product_id
string
required

Paddle ID of the product entity to work with.

Example:

"pro_01gsz4vmqbjk3x4vvtafffd540"

Body

application/json

Represents a product entity when updating products.

name
string

Name of this product.

Required string length: 1 - 200
description
string | null

Short description for this product.

Maximum string length: 2048
type
enum<string>
default:standard

Type of item. Standard items are considered part of your catalog and are shown in the Paddle dashboard.

Available options:
custom,
standard
tax_category
enum<string>

Tax category for this product. Used for charging the correct rate of tax. Selected tax category must be enabled on your Paddle account.

Available options:
digital-goods,
ebooks,
implementation-services,
professional-services,
saas,
software-programming-services,
standard,
training-services,
website-hosting
image_url

Image for this product. Included in the checkout and on some customer documents.

Required string length: 0
custom_data
Custom data · object

Your own structured key-value data.

Example:
{ "customer_reference_id": "abcd1234" }
status
enum<string>

Whether this entity can be used in Paddle.

Available options:
active,
archived

Response

OK

data
Product · object
required

Represents a product entity.

meta
Meta · object
required

Information about this response.