> For the complete documentation index, see [llms.txt](https://developer.paddle.com/llms.txt).

# Product and price reports

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

---

[Products](https://developer.paddle.com/api-reference/products/overview.md) and [prices](https://developer.paddle.com/api-reference/prices/overview.md) 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:

{% table %}

- Field
- Description

---

- **Product updated date**
- The date a product was last modified. Matches entities modified on or after the start date and before the end date.

---

- **Price updated date**
- The 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.
  - Active: Entity is active and can be used.
  - Archived: Entity is archived, so can't be used.

---

- **Price status**
- The status of the 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.

{% /table %}

## Report columns

Column headings on product and price reports mirror fields in [the Paddle API](https://developer.paddle.com/api-reference/overview.md). Data is provided in the following columns:

```yaml
title: Products and prices report
type: object
properties:
  product_id:
    type: string
    pattern: ^pro_[a-z\d]{26}$
    description: Unique Paddle ID for this product, prefixed with `pro_`.
    title: Product ID
    examples:
      - pro_01gsz97mq9pa4fkyy0wqenepkz
  product_status:
    type: string
    enum:
      - active
      - archived
    description: Status of this product.
    title: Status
    x-enum-descriptions:
      active:
        description: Entity is active and can be used.
      archived:
        description: Entity is archived, so can't be used.
  product_type:
    type: string
    enum:
      - custom
      - standard
    description: Type of item. Standard items are considered part of your catalog and are shown in the Paddle dashboard.
    title: CatalogType
    x-enum-descriptions:
      custom:
        description: Non-catalog item. Typically created for a specific transaction or subscription. Not returned when listing or shown in the Paddle dashboard.
      standard:
        description: Standard item. Can be considered part of your catalog and reused across transactions and subscriptions easily.
  product_name:
    type: string
    description: Name of this product.
    minLength: 1
    maxLength: 200
  product_description:
    type:
      - string
      - "null"
    description: Short description for this product.
    maxLength: 2048
  product_tax_category:
    type: string
    enum:
      - digital-goods
      - ebooks
      - implementation-services
      - professional-services
      - saas
      - software-programming-services
      - standard
      - training-services
      - website-hosting
    description: Tax category for this product. Used for charging the correct rate of tax. Selected tax category must be enabled on your Paddle account.
    title: Tax category
    x-enum-descriptions:
      digital-goods:
        description: 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:
        description: Digital books and educational material which is sold with permanent rights for use by the customer.
      implementation-services:
        description: Remote configuration, set-up, and integrating software on behalf of a customer.
      professional-services:
        description: Services that involve the application of your expertise and specialized knowledge of a software product.
      saas:
        description: Products that allow users to connect to and use online or cloud-based applications over the Internet.
      software-programmin-services:
        description: Services that can be used to customize and white label software products.
      standard:
        description: Software products that are pre-written and can be downloaded and installed onto a local device.
      training-services:
        description: Training and education services related to software products.
      website-hosting:
        description: Cloud storage service for personal or corporate information, assets, or intellectual property.
  product_image_url:
    description: Image for this product. Included in the checkout and on some customer documents.
    oneOf:
      - type: "null"
      - type: string
        minLength: 0
        maxLength: 0
      - type: string
        format: uri
        minLength: 1
  product_external_id:
    description: Reference or identifier for this entity from the solution where it was imported from.
    type:
      - string
      - "null"
    examples:
      - 9b95b0b8-e10f-441a-862e-1936a6d818ab
    maxLength: 200
    minLength: 1
  product_custom_data:
    type: object
    unevaluatedProperties: {}
    description: Your own structured key-value data for this product.
    title: Custom Data
    example:
      customer_reference_id: abcd1234
  product_created_at:
    type: string
    format: date-time
    description: RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
    title: Created at
    examples:
      - "2024-10-12T07:20:50.52Z"
    readOnly: true
  product_updated_at:
    type: string
    format: date-time
    description: RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
    title: Updated at
    examples:
      - "2024-10-13T07:20:50.52Z"
    readOnly: true
  price_id:
    type: string
    pattern: ^pro_[a-z\d]{26}$
    description: Unique Paddle ID for this product, prefixed with `pro_`.
    title: Product ID
    examples:
      - pro_01gsz97mq9pa4fkyy0wqenepkz
  price_status:
    type: string
    enum:
      - active
      - archived
    description: Status of this product.
    title: Status
    x-enum-descriptions:
      active:
        description: Entity is active and can be used.
      archived:
        description: Entity is archived, so can't be used.
  price_type:
    type: string
    enum:
      - custom
      - standard
    description: Type of item. Standard items are considered part of your catalog and are shown in the Paddle dashboard.
    title: CatalogType
    x-enum-descriptions:
      custom:
        description: Non-catalog item. Typically created for a specific transaction or subscription. Not returned when listing or shown in the Paddle dashboard.
      standard:
        description: Standard item. Can be considered part of your catalog and reused across transactions and subscriptions easily.
  price_name:
    type:
      - string
      - "null"
    minLength: 1
    maxLength: 50
    description: Name of this price, shown to customers at checkout and on invoices. Typically describes how often the related product bills.
  price_description:
    type: string
    minLength: 2
    maxLength: 200
    description: Internal description for this price, not shown to customers. Typically notes for your team.
  price_tax_mode:
    type: string
    enum:
      - account_setting
      - external
      - internal
      - location
    description: How tax is calculated for this price.
    title: Tax mode
    x-enum-descriptions:
      account_setting:
        description: Prices use the setting from your account.
      external:
        description: Prices are exclusive of tax.
      internal:
        description: Prices are inclusive of tax.
      location:
        description: Prices are inclusive or exclusive of tax, depending on the country of the transaction.
  unit_price_amount:
    type: string
    description: Base price. Amount in the lowest denomination for the currency, e.g. 10 USD = 1000 (cents).
  unit_price_currency:
    type: string
    enum:
      - USD
      - EUR
      - GBP
      - JPY
      - AUD
      - CAD
      - CHF
      - HKD
      - SGD
      - SEK
      - ARS
      - BRL
      - CLP
      - CNY
      - COP
      - CZK
      - DKK
      - HUF
      - ILS
      - INR
      - KRW
      - MXN
      - NOK
      - NZD
      - PEN
      - PLN
      - RUB
      - THB
      - TRY
      - TWD
      - UAH
      - VND
      - ZAR
    description: Currency for the base price. Supported three-letter ISO 4217 currency code.
    title: Currency code
    x-enum-descriptions:
      USD:
        description: United States Dollar
      EUR:
        description: Euro
      GBP:
        description: Pound Sterling
      JPY:
        description: Japanese Yen
      AUD:
        description: Australian Dollar
      CAD:
        description: Canadian Dollar
      CHF:
        description: Swiss Franc
      HKD:
        description: Hong Kong Dollar
      SGD:
        description: Singapore Dollar
      SEK:
        description: Swedish Krona
      ARS:
        description: Argentine Peso
      BRL:
        description: Brazilian Real
      CLP:
        description: Chilean Peso
      CNY:
        description: Chinese Yuan
      COP:
        description: Colombian Peso
      CZK:
        description: Czech Koruna
      DKK:
        description: Danish Krone
      HUF:
        description: Hungarian Forint
      ILS:
        description: Israeli Shekel
      INR:
        description: Indian Rupee
      KRW:
        description: South Korean Won
      MXN:
        description: Mexican Peso
      NOK:
        description: Norwegian Krone
      NZD:
        description: New Zealand Dollar
      PEN:
        description: Peruvian Sol
      PLN:
        description: Polish Zloty
      RUB:
        description: Russian Ruble
      THB:
        description: Thai Baht
      TRY:
        description: Turkish Lira
      TWD:
        description: New Taiwan Dollar
      UAH:
        description: Ukrainian Hryvnia
      VND:
        description: Vietnamese Dong
      ZAR:
        description: South African Rand
  unit_price_overrides:
    description: List of unit price overrides. Use to override the base price with a custom price and currency for a country or group of countries.
    type:
      - string
      - "null"
  price_minimum_quantity:
    type: integer
    description: Minimum quantity of the product related to this price that can be bought. Required if `maximum` set.
    minimum: 1
    default: 1
    examples:
      - 1
    maximum: 999999999
  price_maximum_quantity:
    type: integer
    description: 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.
    minimum: 1
    default: 100
    examples:
      - 100
    maximum: 999999999
  price_billing_cycle_interval:
    description: Unit of time for how often this price should be charged. `null` if price is non-recurring (one-time).
    type:
      - string
      - "null"
    enum:
      - day
      - week
      - month
      - year
  price_billing_cycle_frequency:
    description: Amount of time for how often this price should be charged. `null` if price is non-recurring (one-time).
    type:
      - integer
      - "null"
    minimum: 1
  price_trial_period_interval:
    description: 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.
    type:
      - string
      - "null"
    enum:
      - day
      - week
      - month
      - year
  price_trial_period_frequency:
    description: 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.
    type:
      - integer
      - "null"
    minimum: 1
  price_external_id:
    description: Reference or identifier for this entity from the solution where it was imported from.
    type:
      - string
      - "null"
    examples:
      - 9b95b0b8-e10f-441a-862e-1936a6d818ab
    maxLength: 200
    minLength: 1
  price_custom_data:
    type: object
    unevaluatedProperties: {}
    description: Your own structured key-value data for this price.
    title: Custom Data
    example:
      customer_reference_id: abcd1234
  price_created_at:
    type: string
    format: date-time
    description: RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
    title: Created at
    examples:
      - "2024-10-12T07:20:50.52Z"
    readOnly: true
  price_updated_at:
    type: string
    format: date-time
    description: RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
    title: Updated at
    examples:
      - "2024-10-13T07:20:50.52Z"
    readOnly: true
```