Update a product group’s name, description, rules, or product list.
POST /v1/actions/subscription-product-group/update-group
Request Body
| Field | Type | Required | Description |
|---|
id | string | Yes | Group ID (UUID format) |
name | string | No | Updated group name |
description | string | No | Updated description |
rules | object | No | Updated rules ({ sharedTrial: boolean }) |
productIds | string[] | No | Updated product list (PROD_xxx format). Replaces the entire list. |
Example Request
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.
Error Responses
| Status | Condition |
|---|
400 | Missing required field (id) |
404 | Group not found |
