1. Docs
2. /
3. Tool reference
4. /
5. Commerce
6. /
7. setIncludedItemsPolicy

Commerce

setIncludedItemsPolicy

Set Included Items Policy

Set the "first N included, then X each" pricing policy on a modifier group.

write

Arguments

• appIdstringrequiredThe Studio app ID whose catalog to edit.
• groupIdstringrequiredThe modifier group ID the policy governs.
• includedCountintegerrequiredHow many zero-priced choices are included, e.g. 2.
• overflowPriceMinorintegerrequiredPrice per included-price choice beyond the included count, e.g. 500 = $5.00.
• paidChoicesConsumeIncludedbooleanoptionaltrue = a priced choice also uses up one included position. Defaults false.
• productIdstringoptionalOverride the policy for this one product. Omit for the default.

Returns

The registry does not declare a return shape.

Declared limits

• includedCount: minimum 0
• includedCount: maximum 9007199254740991
• overflowPriceMinor: minimum 0
• overflowPriceMinor: maximum 9007199254740991

Ask for it

The Cloud routes these requests to this verb.

• first two accessories are included, then $5 each
• include three customizations

Pair it with

The verbs that finish the job.

• authorModifierGroup
• getProductConfiguration