Product Groups

Product groups are used to organize products within a brand. They act as containers for products that share similar attributes or belong to the same category. Each product group can have up to 10 custom variables associated with it (VAR1-VAR10), allowing for flexible product differentiation within the group. These variables can be defined with different types, options, descriptions, and prompts.

Optionally, you can prompt your customer for the value of a variable during the checkout/subscribe flow. For example, for a product group of web hosting plans you may want to prompt for a variable named "domain" so you can setup the hosting package with the customers existing domain.

Product groups also support an action_url which acts similar to a traditional webhook. If set, RecurringStack™ will send a POST request with all order variables when events occur on subscriptions for a product in the product group. The 'action_url' will be notified for the following events: 'new_subscription'; 'renew_subscription'; 'swap_subscription'; 'status_subscription'; and 'cancel_subscrption'.

The following API services are available for Product Groups:

Listing product groups: Users can list all product groups associated with a specific brand and account using the List method. The API returns details like the product group ID, name, description, creation date, status, associated product count, action URL, and the defined variables. Pagination is supported to handle large numbers of product groups.

Creating a product group: The Create method allows users to define new product groups. Required information includes a name, description, and optionally an action URL (validated via HTTP check) and up to 10 variable definitions in JSON format. The API returns the details of the newly created product group upon successful creation.

Updating a product group: The Update method enables modifications to existing product groups. Users can update details like the name, description, action URL, and variable definitions. The product_group_id is required to identify the product group to update. The API returns the updated product group details.

Suspending a product group: The Suspend method allows users to temporarily disable a product group. Suspended groups are no longer active but can be restored later. This is achieved by changing the STATUS field of the product group.

Deleting a product group: The Delete method permanently removes a product group. This action should be used with caution as deleted product groups cannot be recovered after a 90 days period has elapsed since the deletion date. This is achieved by changing the STATUS field of the product group.

Restoring a product group: The Restore method re-activates a previously suspended or deleted product group. Suspended groups can be restored at any time, but deleted product groups can only be restored within 90 days of their deletion date. This is achieved by changing the STATUS field of the product group and clearing the deletion date.

Each product group is linked to a specific account and brand, providing an organizational structure for managing product offerings within the RecurringStack™ system. The variables associated with each group give flexibility in defining custom product attributes and variations without creating individual products for each minor variation.