Products report

The Products report lists your product catalogue with each product's type, price, status and group.

To generate it, see Create and download reports.


Filters

All filters are optional. This report has no date range. You can pick more than one value in each list.

  • Name, Merchant Product ID: text to search for in these fields.
  • Product Type: the purchase type, such as Single payment, Instalment, Subscription or Metered. See Purchase types.
  • Product Status: Active or Inactive.
  • Product Group: the groups you created for this profile.
  • Product Currency: the currencies set up for this profile.

Columns

FieldDescription
NameThe name of the product
Merchant Product IDIdentifier for the product that was entered by the user or automatically generated.
Product TypePurchase type of the product. This may differ from the purchase type of the order. Can be single_payment, instalment, subscription, or metered.
PriceThis is the full purchase price for a single purchase or instalment product, the amount to be collected at each scheduled billing event for a subscription, or the initial price for a metered product.
Initial Payment AmountThe amount to be charged immediately, if any. For instalment products, this amount can be 0. In this case, a pre-authorisation transaction for a small amount is reserved on the user's card and released after a few days. For a single purchase order, this is the full purchase price of the products. For a subscription, this is the amount to be collected at each scheduled billing event, with any fee and discount applied.
CurrencyThe product pricing currency, which is one of the acceptance currencies of the merchant. A currency code with 3 letters in ISO 4217 format.
Product StatusActive products can be added to orders. Inactive products can't.
Product GroupAn optional group that the product belongs to.

The file name has the format 000_Products_MerchantName_DDMMYYYY.csv.


Did this page help you?