Product and price reports

Generate detailed reports about your product catalog, including products and prices.

Products and prices form your product catalog. They're things that customers buy.

You can generate reports through the dashboard or via the API.

Report filters

When generating product and price reports, you can filter by:

FieldDescription
Product updated dateThe date a product was last modified. Matches entities modified on or after the start date and before the end date.
Price updated dateThe date a price was last modified. Matches entities modified on or after the start date and before the end date.
Product status

The status of the product or price.

  • Active: Entity is active and can be used.
  • Archived: Entity is archived, so can't be used.
Price status

The status of the product or price.

  • Active: Entity is active and can be used.
  • Archived: Entity is archived, so can't be used.
Price type

Kind of product or price.

  • Custom: Non-catalog product or price. Typically created for a specific transaction or subscription. Not returned when listing products or prices or shown in the Paddle dashboard.
  • Standard: Standard product or price. Can be considered part of your product catalog and reused across transactions and subscriptions easily.
Product type

Kind of product or price.

  • Custom: Non-catalog product or price. Typically created for a specific transaction or subscription. Not returned when listing products or prices or shown in the Paddle dashboard.
  • Standard: Standard product or price. Can be considered part of your product catalog and reused across transactions and subscriptions easily.

Report columns

Column headings on product and price reports mirror fields in the Paddle API. Data is provided in the following columns:

product_idstring

Unique Paddle ID for this product, prefixed with pro_.

product_statusstring

Status of this product.

product_typestring

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

product_namestring

Name of this product.

product_descriptionstring or null

Short description for this product.

product_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.

product_image_urlnull or string<uri>

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

product_external_idstring or null

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

product_custom_dataobject

Your own structured key-value data for this product.

product_created_atstring<date-time>

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

product_updated_atstring<date-time>

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

price_idstring

Unique Paddle ID for this product, prefixed with pro_.

price_statusstring

Status of this product.

price_typestring

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

price_namestring or null

Name of this price, shown to customers at checkout and on invoices. Typically describes how often the related product bills.

price_descriptionstring

Internal description for this price, not shown to customers. Typically notes for your team.

price_tax_modestring

How tax is calculated for this price.

unit_price_amountstring

Base price. Amount in the lowest denomination for the currency, e.g. 10 USD = 1000 (cents).

unit_price_currencystring

Currency for the base price. Supported three-letter ISO 4217 currency code.

unit_price_overridesstring or null

List of unit price overrides. Use to override the base price with a custom price and currency for a country or group of countries.

price_minimum_quantityinteger

Minimum quantity of the product related to this price that can be bought. Required if maximum set.

price_maximum_quantityinteger

Maximum quantity of the product related to this price that can be bought. Required if minimum set. Must be greater than or equal to the minimum value.

price_billing_cycle_intervalstring or null

Unit of time for how often this price should be charged. null if price is non-recurring (one-time).

price_billing_cycle_frequencyinteger or null

Amount of time for how often this price should be charged. null if price is non-recurring (one-time).

price_trial_period_intervalstring or null

Unit of time for the trial period for the product related to this price. The billing cycle begins once the trial period is over. null for no trial period.

price_trial_period_frequencyinteger or null

Amount of time for the trial period for the product related to this price. The billing cycle begins once the trial period is over. null for no trial period.

price_external_idstring or null

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

price_custom_dataobject

Your own structured key-value data for this price.

price_created_atstring<date-time>

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

price_updated_atstring<date-time>

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

Related pages