Products report
The Products report gives you all the details of your product catalogue.
- To create and download this report, see the instructions at Create and download reports.
You can customise the Products report to display groups of products using the following filters.
- Name, Merchant Product ID, which is text to search for in these fields.
- Product type, which is the same as a purchase type. See Purchase types
- Product status, which is
active
orinactive
. - Product group, which is any of the groups you created to categorise your products.
- Product currency, which is any of the acceptance currencies configured for your merchant.
The Products report contains the following fields.
Field | Description |
---|---|
Name | The name of the product |
Merchant Product ID | Identifier for the product that was entered by the user or automatically generated. |
Product Type | Purchase type of the product. This may differ from the purchase type of the order, if the product payment configuration is not locked. Can be single_payment , instalment , subscription , or metered . |
Price | For a single purchase or instalment product, this is the full purchase price. For a subscription, this is the amount to be collected at each scheduled billing event. For a metered product, this is the initial price. |
Initial Payment Amount | 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 amount to be collected at each scheduled billing event, with any initial fee and discount applied. |
Currency | The product pricing currency, which is one of the acceptance currencies for the merchant. A currency code with 3 letters in ISO 4217 format. |
Product Status | If a product has the Active status, you can select it in orders. If a product has the Inactive or dormant status, you cannot select it in orders. |
Product Group | An optional group that the product belongs to |
You can download the report as a CSV file, and the file name has the format 000_Products_MerchantName_DDMMYYYY.csv
.
To create and download this report, see the instructions at Create and download reports.
Updated about 1 month ago
Recommended reading
Generate and download other BillPro reports