subscriptions_tool
Subscriptions module on the selected site (call select_site first). Tariff plans, user subscriptions, access checks, payments. Not shop_tool, users_tool, or content_tool. Module must be installed via modules_tool. Proxies to /uapi/subscriptions/* with a server-minted Bearer key.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| p | No | Page number (OpenAPI p). | |
| id | No | Legacy tariff id for /item endpoints. | |
| page | No | Synonym for p on list actions. | |
| type | No | Plan type: 0 free, 1 one-time, 2 recurring, 3 donate. | |
| price | No | ||
| query | No | Search query for subscribers/payments lists. | |
| title | No | Plan title (plan_add/update). | |
| action | Yes | Subscriptions action. Destructive actions need confirm: true after user approval. | |
| amount | No | Payment amount in minor currency units. | |
| fields | No | Extra form fields per OpenAPI. | |
| period | No | Recurring period in days. | |
| status | No | Status filter (comma-separated). | |
| confirm | No | Required for destructive actions after user approval. | |
| date_to | No | Payment date upper bound (unix). | |
| plan_id | No | Tariff plan id. | |
| user_id | No | User id. | |
| currency | No | ISO 4217 code, e.g. RUB. | |
| group_to | No | Group id while subscription is active. | |
| interval | No | Subscription interval in days. | |
| date_from | No | Payment date lower bound (unix). | |
| price_old | No | ||
| group_back | No | Group id after subscription ends. | |
| payment_id | No | Payment id. | |
| description | No | Plan description. | |
| is_discount | No | ||
| is_advantage | No | ||
| expires_before | No | Unix timestamp filter. | |
| text_advantage | No | ||
| transaction_id | No | Idempotent payment transaction id. | |
| trial_interval | No | ||
| advantage_items | No | Advantage lines separated by newline. | |
| subscription_id | No | Subscription id. | |
| payment_method_id | No |