The Product catalog screen, under Products in the sidebar, is where you manage
Products and their Prices without writing code. It reads and writes the same
/v1/products and /v1/prices your code calls, so a product you add here is the one your integration finds. The
screen shows the catalog of the mode you are in: test mode and live mode each keep their own products.
The list#
Each row shows the product's image, name, the default price, and when it was created and updated. The pricing
column shows — when no default price is set, or the expanded default price. It
does not count the product's other prices. The All, Active and Archived tabs filter by status.
The search box takes any text, up to 200 characters. When the text is a product's id, a generated prod_... one or one
you chose when you created the product, that product is listed first, then the products the text matches:
- On All, the text is matched in the name or the description.
- On Active and Archived, the text is matched in the name only, since one search can't mix the status with name or description.
- Text of 3 characters or more matches inside words. Shorter text matches whole words only.
The search runs over the whole catalog of the store, through product search.
Add a product#
Add product opens a form with:
- Name, required, and Description, shown to customers at checkout.
- Image: one image, JPEG, PNG or WEBP up to 2 MB. The dashboard stores it and keeps its public link in the
product's
images. - More options: statement descriptor (up to 22 characters), unit label (up to 12), URL and tax code.
- Metadata: up to 50 keys, each key up to 40 characters and each value up to 500.
- Pricing: one or more prices. Each has an amount and a currency. More pricing options add a price description, which only you see, and a lookup key.
The currency list holds the store's own currency first, then USD, BRL, EUR, GBP, CAD, AUD, MXN and JPY. The API takes more currencies; the dashboard offers these eight.
The first price becomes the product's default price. The other prices are saved one by one after the product. If one fails, the product is still added, the form lists the prices that were not saved, and Try the prices again retries them.
A product's page#
Click a product to open it. Its page shows the pricing table (price, lookup key, status, created), the details and the metadata. From there you can:
- Edit product and Edit the metadata.
- Add another price, and set it as the default at once.
- From a price's menu: Set as default price, Edit price, Archive price or Unarchive price, and Copy price ID. Editing a price changes its description, lookup key, and metadata only: a price's amount and currency never change, so add a new price and archive the old one. The default price can't be archived, and an archived price can't become the default.
- From the product's menu: Archive product or Unarchive product, Copy product ID and Delete product.
Archive or delete#
Archive a product you no longer sell. It stays in the Archived tab with its prices, payments already made are not affected, and you can unarchive it at any time.
Delete product removes it for good, and only works for a product with no prices. When the product has prices, the dialog shows the refusal and offers Archive instead. See Archive or delete.