Product groups differ from product families: While product families are only for organizing the catalog, product groups control the switching options between products.
Use Cases
| Scenario | Description |
|---|---|
| Tier Change | Customer switches from Starter to Pro package |
| Upgrade | Customer books a higher-value package |
| Downgrade | Customer switches to a cheaper package |
| Quantity Change | Customer changes the number of licenses |
Concept
A product group consists of multiple tiers, each representing a product with its price plans. The order of tiers determines the upgrade/downgrade direction.- Upgrade: Switch to a higher position (e.g., Starter → Pro)
- Downgrade: Switch to a lower position (e.g., Pro → Starter)
Create Product Group
- Using Web App
- Using API
Create Product Group
Navigate to Products > Product Groups and click “Create Product Group”.Assign a name like “SaaS Packages” or “Hosting Plans”.
Add Tiers
Add a tier for each package:
- Select the Product (e.g., “Starter Plan”)
- Select the Price Plans (e.g., “Starter Monthly”, “Starter Yearly”)
- Configure Upgrade/Downgrade behavior
Tier Settings
Each tier in a product group has the following settings:Upgrade & Downgrade
| Setting | Description |
|---|---|
| Upgradeable | Can switch to higher positions |
| Downgradeable | Can switch to lower positions |
Change Timing
| Option | Description |
|---|---|
Immediately (immediately) | Change becomes active immediately |
End of Period (end_of_period) | Change becomes active at end of current billing period |
Credit Type
Only relevant whenchangeTiming = immediately:
| Option | Description |
|---|---|
Pro Rata (pro_rata) | Credit based on remaining days |
Full (full) | Full credit of current period |
Last Invoiced (last_invoiced) | Credit of last invoice |
None (none) | No credit |
Assign Product Group
For customers to be able to switch, the product group must be assigned to a subscription item.- Using Web App
- Using API
Perform Switch
In Customer Portal
Once a product group is assigned, customers see available switch options in the customer portal:- Customer opens their subscription
- Clicks “Change”
- Selects new package and confirms
- Change is applied immediately or at period end based on configuration
Via API
Settings
Force Same Billing Interval
WithforceSameBillingInterval: true, customers can only switch between price plans with the same billing interval. A customer with a monthly plan will only see monthly options.
API Overview
| Endpoint | Method | Description |
|---|---|---|
/catalogue/product-groups | GET | Get all product groups |
/catalogue/product-groups | POST | Create new product group |
/catalogue/product-groups/{id} | GET | Get single product group |
/catalogue/product-groups/{id} | PUT | Update product group |
/catalogue/product-groups/{id} | DELETE | Delete product group |
/subscription-items/{id}/product-group | PUT | Enable up- & downgrades |
/subscription-items/{id}/change-options | GET | Get available switch options |
/product-group-memberships/{id}/apply | POST | Change tier |