Paddle Billing
Search

Update a product

Updates a product using its ID.

Paddle does not upload product images to a CDN. For image_url, you should host images on an HTTPS server that's publicly accessible. We recommend using square images (1:1 ratio).

If successful, your response includes a copy of the updated product entity.

Path Parameters

product_idstringrequired

Paddle ID of the product entity to work with.

Request Body

namestring

Name of this product.

descriptionstring or null

Short description for this product.

typestring

Type of item. Standard items are considered part of your catalog and are shown on the Paddle web app.

tax_categorystring

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

image_urlnull or string<uri>

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

custom_dataobject or null

Your own structured key-value data.

statusstring

Whether this entity can be used in Paddle.

Response

dataobject

Represents a product entity.

idstring

Unique Paddle ID for this product, prefixed with pro_.

namestring

Name of this product.

descriptionstring or null

Short description for this product.

typestring

Type of item. Standard items are considered part of your catalog and are shown on the Paddle web app.

tax_categorystring

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

image_urlstring<uri> or null

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

custom_dataobject or null

Your own structured key-value data.

statusstring

Whether this entity can be used in Paddle.

import_metaobject or null

Import information for this entity. null if this entity is not imported.

created_atstring<date-time>

RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.

updated_atstring<date-time>

RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.

metaobject

Information about this response.

request_idstring

Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.