Update a product group’s name, description, rules, or product list.
POST /v1/actions/subscription-product-group/update-group
Authentication: API Key
Request Body
Field Type Required Description idstring Yes Group ID (UUID format) namestring No Updated group name descriptionstring No Updated description rulesobject No Updated rules ({ sharedTrial: boolean }) productIdsstring[] No Updated product list (PROD_xxx format). Replaces the entire list.
Example Request
SDK
TypeScript (fetch)
Java
Python
Go
Rust
C
C++
cURL
wget
const { group } = await client . subscriptionProductGroups . update ({
id: "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f9a" ,
name: "Updated Pricing Plans" ,
productIds: [
"PROD_3F7H2J5L8N1Q4S6U" ,
"PROD_8B4D6F9H2K5M7P1R" ,
],
});
The productIds field replaces the entire product list . To add a product, include all existing product IDs plus the new one. To remove a product, omit it from the list.
Errors
Retry policy: Never retry 4xx — fix the request and resubmit. Retry 5xx with exponential backoff (start 5s, max 3 attempts).
Status errors[0].messageWhat it means Recommended handling 400 Missing required field: idRequest body did not include id Add id, resubmit 400 Expected format: PROD_xxx, got "..."A productIds entry could not be decoded as a Short ID Fix the ID, resubmit 404 Group not foundNo group exists for the supplied id Verify the id belongs to your store 500 Internal server errorInternal error or transient downstream failure Retry with exponential backoff (start 5s, max 3 attempts)