apple_create_subscription_offer_code
Create custom or one-time-use subscription offer codes for distribution outside the App Store. Provide per-territory prices, looked up first with apple_get_subscription_price_points.
Instructions
Create a subscription offer code (custom or one-time-use codes distributed outside the App Store). Requires per-territory prices — look them up first with apple_get_subscription_price_points.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"subscriptionId": "<subscriptionId>",
"name": "<name>",
"customerEligibilities": "<customerEligibilities>",
"offerEligibility": "<offerEligibility>",
"duration": "<duration>",
"offerMode": "<offerMode>",
"numberOfPeriods": "<numberOfPeriods>",
"prices": "<prices>"
},
"name": "apple_create_subscription_offer_code"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Internal reference name for the offer code | |
| prices | Yes | Per-territory prices for the offer | |
| duration | Yes | Billing period duration of the offer | |
| offerMode | Yes | Offer pricing mode | |
| subscriptionId | Yes | Subscription ID | |
| numberOfPeriods | Yes | Number of billing periods the offer applies for | |
| autoRenewEnabled | No | Whether the subscription auto-renews after the offer period | |
| offerEligibility | Yes | How this offer interacts with introductory offers | |
| customerEligibilities | Yes | Which customers are eligible |