Pay: plans update
pay_plans_updateUpdate a subscription plan, keeping omitted fields unchanged. Toggle active or inactive to show or hide it in the plan picker; price changes apply to new sign-ups. Confirm before applying.
Instructions
Update a subscription plan (any --flag overrides; unset = keep). Changes a subscription plan; omitted fields keep their current values, and active or inactive shows or hides it from the plan picker. Changing the amount, currency or interval points the plan at a new Stripe price for new sign-ups; existing subscriptions keep their old price. Prefer inactive over pay_plans_delete. It changes or deletes existing data, so check with the user before running it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Plan id to update. Find it with pay_plans_list. | |
| name | No | Display name shown to subscribers | |
| type | No | Plan type (create default: web; update keeps the current value) | |
| active | No | Mark the plan active | |
| amount | No | Recurring amount (decimal, in the plan's currency) | |
| currency | No | Currency code (create default: gbp; update keeps the current value) | |
| inactive | No | Mark the plan inactive (hidden from picker) | |
| interval | No | Billing interval: day, week, month, year (create default: month; update keeps the current value) | |
| plan_name | No | Internal plan identifier (e.g. "trial", "monthly", "annual") | |
| reference | No | Internal reference / external id (optional) | |
| tier_rank | No | Plan tier rank (update keeps the current value) | |
| trial_days | No | Trial period length in days (optional) | |
| description | No | Description | |
| product_name | No | Stripe product display name (optional, defaults to Name) | |
| interval_count | No | Number of intervals per billing cycle (create default: 1; update keeps the current value) | |
| apple_product_id | No | Apple App Store product id for this plan (optional) | |
| product_description | No | Stripe product description (optional) | |
| apple_subscription_group_id | No | Apple subscription group id (optional; auto-filled on first verify) |