For AI agents and LLMs: a structured documentation index is available at /llms.txt. Every page has a Markdown sibling — append .md to any URL.

Skip to content
Docs

Product and price reports

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

AI summary

Product and price reports export your full catalog with filters for status (active, archived) and type (standard, custom), letting you audit your offering and sync catalog data with external systems.

  • • Product and price updated date filters are independent, so you can target recently modified items in either entity separately.
  • • The type filter separates standard catalog items from custom non-catalog items created for specific transactions — custom items don't appear in the dashboard.
  • • Column headings mirror the Paddle API product and price entity fields, making it straightforward to reconcile exported data with API responses.

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

When to use

  • Audit your product catalog
    Review all products and prices, including active and archived items.
  • Sync catalog with external systems
    Export catalog data for accounting, ERP, or BI tools.
  • Investigate catalog changes
    Filter by updated date to surface recently modified products and prices.

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 statusThe status of the product.
  • Active: Entity is active and can be used.
  • Archived: Entity is archived, so can't be used.
Price statusThe status of the price.
  • Active: Entity is active and can be used.
  • Archived: Entity is archived, so can't be used.
Price typeKind 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 typeKind 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
Example: pro_01gsz97mq9pa4fkyy0wqenepkz
Unique Paddle ID for this product, prefixed with pro_.
Pattern: ^pro_[a-z\d]{26}$
product_statusstring
Status of this product.
Values
  • active
    Entity is active and can be used.
  • archived
    Entity is archived, so can't be used.
product_typestring
Type of item. Standard items are considered part of your catalog and are shown in the Paddle dashboard.
Values
  • custom
    Non-catalog item. Typically created for a specific transaction or subscription. Not returned when listing or shown in the Paddle dashboard.
  • standard
    Standard item. Can be considered part of your catalog and reused across transactions and subscriptions easily.
product_namestring
Name of this product.
Length: 1–200
product_descriptionstring | null
Short description for this product.
Max length: 2048
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.
Values
  • digital-goods
    Non-customizable digital files or media (not software) acquired with an up front payment that can be accessed without any physical product being delivered.
  • ebooks
    Digital books and educational material which is sold with permanent rights for use by the customer.
  • implementation-services
    Remote configuration, set-up, and integrating software on behalf of a customer.
  • professional-services
    Services that involve the application of your expertise and specialized knowledge of a software product.
  • saas
    Products that allow users to connect to and use online or cloud-based applications over the Internet.
+ Show all values
  • software-programming-services
  • standard
    Software products that are pre-written and can be downloaded and installed onto a local device.
  • training-services
    Training and education services related to software products.
  • website-hosting
    Cloud storage service for personal or corporate information, assets, or intellectual property.
product_image_url
Image for this product. Included in the checkout and on some customer documents.
null
string
string (uri)
product_external_idstring | null
Example: 9b95b0b8-e10f-441a-862e-1936a6d818ab
Reference or identifier for this entity from the solution where it was imported from.
Length: 1–200
product_custom_dataobject
Example: {"customer_reference_id":"abcd1234"}
Your own structured key-value data for this product.
product_created_atstring (date-time)
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
product_updated_atstring (date-time)
Example: 2024-10-13T07:20:50.52Z
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
price_idstring
Example: pro_01gsz97mq9pa4fkyy0wqenepkz
Unique Paddle ID for this product, prefixed with pro_.
Pattern: ^pro_[a-z\d]{26}$
price_statusstring
Status of this product.
Values
  • active
    Entity is active and can be used.
  • archived
    Entity is archived, so can't be used.
price_typestring
Type of item. Standard items are considered part of your catalog and are shown in the Paddle dashboard.
Values
  • custom
    Non-catalog item. Typically created for a specific transaction or subscription. Not returned when listing or shown in the Paddle dashboard.
  • standard
    Standard item. Can be considered part of your catalog and reused across transactions and subscriptions easily.
price_namestring | null
Name of this price, shown to customers at checkout and on invoices. Typically describes how often the related product bills.
Length: 1–50
price_descriptionstring
Internal description for this price, not shown to customers. Typically notes for your team.
Length: 2–200
price_tax_modestring
How tax is calculated for this price.
Values
  • account_setting
    Prices use the setting from your account.
  • external
    Prices are exclusive of tax.
  • internal
    Prices are inclusive of tax.
  • location
    Prices are inclusive or exclusive of tax, depending on the country of the transaction.
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.
Values
  • USD
    United States Dollar
  • EUR
    Euro
  • GBP
    Pound Sterling
  • JPY
    Japanese Yen
  • AUD
    Australian Dollar
+ Show all values
  • CAD
    Canadian Dollar
  • CHF
    Swiss Franc
  • HKD
    Hong Kong Dollar
  • SGD
    Singapore Dollar
  • SEK
    Swedish Krona
  • ARS
    Argentine Peso
  • BRL
    Brazilian Real
  • CLP
    Chilean Peso
  • CNY
    Chinese Yuan
  • COP
    Colombian Peso
  • CZK
    Czech Koruna
  • DKK
    Danish Krone
  • HUF
    Hungarian Forint
  • ILS
    Israeli Shekel
  • INR
    Indian Rupee
  • KRW
    South Korean Won
  • MXN
    Mexican Peso
  • NOK
    Norwegian Krone
  • NZD
    New Zealand Dollar
  • PEN
    Peruvian Sol
  • PLN
    Polish Zloty
  • RUB
    Russian Ruble
  • THB
    Thai Baht
  • TRY
    Turkish Lira
  • TWD
    New Taiwan Dollar
  • UAH
    Ukrainian Hryvnia
  • VND
    Vietnamese Dong
  • ZAR
    South African Rand
unit_price_overridesstring | 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
Default: 1
Example: 1
Minimum quantity of the product related to this price that can be bought. Required if maximum set.
Range: 1–999999999
price_maximum_quantityinteger
Default: 100
Example: 100
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.
Range: 1–999999999
price_billing_cycle_intervalstring | null
Unit of time for how often this price should be charged. null if price is non-recurring (one-time).
Values
  • day
  • week
  • month
  • year
price_billing_cycle_frequencyinteger | null
Amount of time for how often this price should be charged. null if price is non-recurring (one-time).
Min: 1
price_trial_period_intervalstring | 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.
Values
  • day
  • week
  • month
  • year
price_trial_period_frequencyinteger | 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.
Min: 1
price_external_idstring | null
Example: 9b95b0b8-e10f-441a-862e-1936a6d818ab
Reference or identifier for this entity from the solution where it was imported from.
Length: 1–200
price_custom_dataobject
Example: {"customer_reference_id":"abcd1234"}
Your own structured key-value data for this price.
price_created_atstring (date-time)
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
price_updated_atstring (date-time)
Example: 2024-10-13T07:20:50.52Z
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.

Was this page helpful?