Set Tenant Plan
set_tenant_planMove a tenant (workspace) to another plan, the same change as the plan picker on a workspace in the Bridge dashboard. A paid Stripe subscription is updated to the new plan's price. Use it to clear a plan before delete_plan, or to put a customer on a plan by hand. Arguments: name (the tenant), plan (the plan KEY), and optionally interval and currency to pick one of the plan's prices — without them the plan's first price is used. Fails with TENANT_NOT_FOUND, TENANT_AMBIGUOUS, PLAN_NOT_FOUND or PRICE_NOT_FOUND without changing anything. Before writing app code that consumes this, call get_integration_guide with topic=billing and the framework the app uses.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| app | No | Id of the Bridge app to act on for this call (see list_apps). Omit to use the current app. | |
| name | Yes | Tenant NAME from list_tenants (a tenant id is accepted as a fallback). | |
| plan | Yes | Plan KEY to move the tenant to. | |
| currency | No | Which of the plan's prices: its currency, e.g. USD. | |
| interval | No | Which of the plan's prices: its interval. |