Skip to main content
Update a product group’s name, description, rules, or product list.
POST /v1/actions/subscription-product-group/update-group
Authentication: API Key

Request Body

FieldTypeRequiredDescription
idstringYesGroup ID (UUID format)
namestringNoUpdated group name
descriptionstringNoUpdated description
rulesobjectNoUpdated rules ({ sharedTrial: boolean })
productIdsstring[]NoUpdated 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.

Errors

Retry policy: Never retry 4xx — fix the request and resubmit. Retry 5xx with exponential backoff (start 5s, max 3 attempts).
Statuserrors[0].messageWhat it meansRecommended handling
400Missing required field: idRequest body did not include idAdd id, resubmit
400Expected format: PROD_xxx, got "..."A productIds entry could not be decoded as a Short IDFix the ID, resubmit
404Group not foundNo group exists for the supplied idVerify the id belongs to your store
500Internal server errorInternal error or transient downstream failureRetry with exponential backoff (start 5s, max 3 attempts)