Products

Product entities describe the items that you sell. They hold high-level product attributes.

Products are the items in your catalog that you sell to your customers. For simplicity and flexibility, there's no categories or hierarchies of product — everything you sell starts with a product entity.

Products work with prices, which is where you can say how much you charge for a product and how often.

Product entities hold information like:

What the product is called
How it should be taxed
A description of the product
An image to show at checkout and on invoices

Once you've created a product, you can link a price to it. You can add prices to checkouts, transactions, and subscriptions to bill for your products.

Get a step-by-step overview of how to create a product that's ready-to-sell, including prices and price overrides. See: Create products and prices

There's no delete operation for products. Use the update a product operation to archive products when you no longer need them. See: Delete entities

Attributes

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.

external_idstring or null

Reference or identifier for this entity from the solution where it was imported from.

imported_fromstring

Name of the platform where this entity was imported from.

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.

List products

gethttps://api.paddle.com/products

Create a product

posthttps://api.paddle.com/products

Get a product

gethttps://api.paddle.com/products/{product_id}

Update a product

patchhttps://api.paddle.com/products/{product_id}