Overview
Products fall in one of two general categories:
- One-time products are eligible for one-time sale. After a customer pays for the product, they own it forever.
- Recurring products require a subscription. The customer must pay for the subscription regularly to keep using the product. To learn more, read About Subscriptions.
Product object
A product object can have the following properties:
| Name | Type | Description |
|---|---|---|
id | String | The product ID |
name | String | The product name |
description | String | The product description |
statementDescriptor | String | The description that will be displayed in a bank account or credit card statement when the product is purchased. |
unitLabel | String | Unit label |
imageUrl | String | URL of the product image |
productPrices | Object Array | An array of product price objects |
isActive | Boolean | If True, the product is active. |
setupFee | Number | An optional fee for the set-up of the product |
metadata | Object Array | Any custom properties that need to be added to a product record. The metadata objects are key-value pairs. |
createdDate | DateTime | Date the product record was created |
updatedDate | DateTime | Date the product record was last updated |
isActionsDisabled | Boolean | If True, the actions is disabled. |
enableAffiliateProgram | Boolean | If True, the product is active for affiliate program. |
isFavorite | Boolean | If True, the product is favorite. |