changedInput schema / properties / action / oneOf
Previous value: -[
- {
- "const": "plan_add",
- "description": "Creates a tariff plan. Optional: title, description, type, price, price_old, is_discount, is_advantage, interval, period, trial_interval, group_to, group_back, text_advantage, advantage_items, fields."
- },
- {
- "const": "plan_update",
- "description": "Updates a tariff plan. Required: plan_id. Optional: title, description, type, price, price_old, is_discount, is_advantage, interval, period, trial_interval, group_to, group_back, text_advantage, advantage_items, fields."
- },
- {
- "const": "plan_enable",
- "description": "Enables a tariff plan. Required: plan_id."
- },
- {
- "const": "plan_disable",
- "description": "Disables a tariff plan. Required: plan_id."
- },
- {
- "const": "legacy_item_add",
- "description": "Creates a legacy tariff. Optional: title, description, type, price, price_old, is_discount, is_advantage, interval, period, trial_interval, group_to, group_back, text_advantage, advantage_items, fields."
- },
- {
- "const": "legacy_item_update",
- "description": "Updates a legacy tariff (id in id or plan_id). Optional: id, plan_id, title, description, type, price, price_old, is_discount, is_advantage, interval, period, trial_interval, group_to, group_back, text_advantage, advantage_items, fields."
- },
- {
- "const": "subscription_create",
- "description": "Creates an unpaid subscription of a user to a plan. Instead of a new one it reuses the unpaid subscription of the user to this plan (for a recurring plan also a paused or expired one, which keeps its status), refreshes it from the current plan and clears its saved payment method, so its auto-renewal is lost. Refused when the user has an active or trial subscription to any plan (unless the requested plan is a donation plan). Gives no access, charges nothing and records no payment. Required: user_id, plan_id. Optional: fields."
- },
- {
- "const": "subscription_grant",
- "description": "Grants a user paid access to a plan without any payment: a subscription is created, or an unpaid one of the user to this plan (for a recurring plan also a paused or expired one) is reused and refreshed from the plan, and it is activated at once for one plan period (unlimited when the plan has no period). The user is moved to the plan group, and the user and the site owner are notified. No payment is recorded. Refused when the user has an active or trial subscription to any plan (unless the requested plan is a donation plan). Required: user_id, plan_id, confirm. Optional: fields."
- },
- {
- "const": "subscription_trial",
- "description": "Starts a free trial of a recurring plan that has trial days: the subscription gets the trial status for trial_interval days without a card or any payment. The user group is not changed. Refused when the user already has this plan active, in trial or paused, or has an active or trial subscription to any other plan. Required: user_id, plan_id. Optional: fields."
- },
- {
- "const": "subscription_renew",
- "description": "Extends a subscription by one plan period without payment and without a payment record: from its end date, or from now when it has ended. The subscription becomes active and the user is moved to the plan group, even if it was unpaid, in trial or paused. A cancelled one is refused. When the subscription has a saved payment method, automatic charges are scheduled again, even if auto-renewal was turned off. Required: subscription_id."
- },
- {
- "const": "subscription_change_plan",
- "description": "Moves a subscription to another plan at once: the new price, period and group (for an active or trial subscription) apply now, without extra payment, refund or price recalculation, and the end date stays. Auto-renewal is kept when the new plan is recurring at the same price, and later charges then follow the new plan period; otherwise it is turned off and the saved payment method is removed. PayPal subscriptions are refused. Required: subscription_id, plan_id. Optional: fields."
- },
- {
- "const": "subscription_pause",
- "description": "Pauses a subscription. Required: subscription_id."
- },
- {
- "const": "subscription_resume",
- "description": "Resumes a paused subscription that has not ended: the user is moved back to the plan group, and automatic charges of a saved payment method are scheduled again, even if auto-renewal was turned off before the pause; the next charge may come within the hour when the period ends soon. Required: subscription_id."
- },
- {
- "const": "subscription_autorenew_disable",
- "description": "Turns off auto-renewal of a subscription. Required: subscription_id."
- },
- {
- "const": "payment_create",
- "description": "Records an unpaid payment of a subscription in the module accounts only: nothing is charged, no payment system is contacted, and the subscription does not change. amount is in minor currency units; the payment method must be enabled on the site. Required: subscription_id, amount. Optional: payment_method_id, currency, transaction_id, fields."
- },
- {
- "const": "payment_confirm",
- "description": "Marks an unpaid or awaiting payment as paid without any check that money was received; nothing is charged. The subscription is activated and extended by one plan period, the user is moved to the plan group, and the payment counts in paid totals (plan_stats). The amount is not checked against the plan price. When the subscription has a saved payment method, automatic charges are scheduled again, even if auto-renewal was turned off; the next charge may come within the hour when the plan period is short. Required: payment_id, confirm."
- }
-]New value: +[
+ {
+ "const": "plan_add",
+ "description": "Creates a tariff plan. Required: title. Optional: description, type, price, price_old, is_discount, is_advantage, interval, period, trial_interval, group_to, group_back, text_advantage, advantage_items, fields."
+ },
+ {
+ "const": "plan_update",
+ "description": "Updates a tariff plan. Required: plan_id. Optional: title, description, type, price, price_old, is_discount, is_advantage, interval, period, trial_interval, group_to, group_back, text_advantage, advantage_items, fields."
+ },
+ {
+ "const": "plan_enable",
+ "description": "Enables a tariff plan. Required: plan_id."
+ },
+ {
+ "const": "plan_disable",
+ "description": "Disables a tariff plan. Required: plan_id."
+ },
+ {
+ "const": "legacy_item_add",
+ "description": "Creates a legacy tariff. Required: title. Optional: description, type, price, price_old, is_discount, is_advantage, interval, period, trial_interval, group_to, group_back, text_advantage, advantage_items, fields."
+ },
+ {
+ "const": "legacy_item_update",
+ "description": "Updates a legacy tariff (id in id or plan_id). Required: id or plan_id. Optional: title, description, type, price, price_old, is_discount, is_advantage, interval, period, trial_interval, group_to, group_back, text_advantage, advantage_items, fields."
+ },
+ {
+ "const": "subscription_create",
+ "description": "Creates an unpaid subscription of a user to a plan. Instead of a new one it reuses the unpaid subscription of the user to this plan (for a recurring plan also a paused or expired one, which keeps its status), refreshes it from the current plan and clears its saved payment method, so its auto-renewal is lost. Refused when the user has an active or trial subscription to any plan (unless the requested plan is a donation plan). Gives no access, charges nothing and records no payment. Required: user_id, plan_id. Optional: fields."
+ },
+ {
+ "const": "subscription_grant",
+ "description": "Grants a user paid access to a plan without any payment: a subscription is created, or an unpaid one of the user to this plan (for a recurring plan also a paused or expired one) is reused and refreshed from the plan, and it is activated at once for one plan period (unlimited when the plan has no period). The user is moved to the plan group, and the user and the site owner are notified. No payment is recorded. Refused when the user has an active or trial subscription to any plan (unless the requested plan is a donation plan). Required: user_id, plan_id, confirm. Optional: fields."
+ },
+ {
+ "const": "subscription_trial",
+ "description": "Starts a free trial of a recurring plan that has trial days: the subscription gets the trial status for trial_interval days without a card or any payment. The user group is not changed. Refused when the user already has this plan active, in trial or paused, or has an active or trial subscription to any other plan. Required: user_id, plan_id. Optional: fields."
+ },
+ {
+ "const": "subscription_renew",
+ "description": "Extends a subscription by one plan period without payment and without a payment record: from its end date, or from now when it has ended. The subscription becomes active and the user is moved to the plan group, even if it was unpaid, in trial or paused. A cancelled one is refused. When the subscription has a saved payment method, automatic charges are scheduled again, even if auto-renewal was turned off. Required: subscription_id."
+ },
+ {
+ "const": "subscription_change_plan",
+ "description": "Moves a subscription to another plan at once: the new price, period and group (for an active or trial subscription) apply now, without extra payment, refund or price recalculation, and the end date stays. Auto-renewal is kept when the new plan is recurring at the same price, and later charges then follow the new plan period; otherwise it is turned off and the saved payment method is removed. PayPal subscriptions are refused. Required: subscription_id, plan_id. Optional: fields."
+ },
+ {
+ "const": "subscription_pause",
+ "description": "Pauses a subscription. Required: subscription_id."
+ },
+ {
+ "const": "subscription_resume",
+ "description": "Resumes a paused subscription that has not ended: the user is moved back to the plan group, and automatic charges of a saved payment method are scheduled again, even if auto-renewal was turned off before the pause; the next charge may come within the hour when the period ends soon. Required: subscription_id."
+ },
+ {
+ "const": "subscription_autorenew_disable",
+ "description": "Turns off auto-renewal of a subscription. Required: subscription_id."
+ },
+ {
+ "const": "payment_create",
+ "description": "Records an unpaid payment of a subscription in the module accounts only: nothing is charged, no payment system is contacted, and the subscription does not change. amount is in minor currency units; the payment method must be enabled on the site. Required: subscription_id, amount. Optional: payment_method_id, currency, transaction_id, fields."
+ },
+ {
+ "const": "payment_confirm",
+ "description": "Marks an unpaid or awaiting payment as paid without any check that money was received; nothing is charged. The subscription is activated and extended by one plan period, the user is moved to the plan group, and the payment counts in paid totals (plan_stats). The amount is not checked against the plan price. When the subscription has a saved payment method, automatic charges are scheduled again, even if auto-renewal was turned off; the next charge may come within the hour when the plan period is short. Required: payment_id, confirm."
+ }
+]