Plans
Change plan shopify
Starts a plan change for a workspace billed through Shopify by creating a Shopify subscription for the requested plan and capped_amount, and returns the Shopify confirmation URL the merchant has to approve. The plan is not changed by this call, it changes when the approval comes back from Shopify, and the call fails without a connected Shopify integration or when capped_amount is below what the plan and current User count need.
POST
/api/{tenant:minlength(2)}/v{version:apiVersion}/plans/change_plan_shopify
Request arguments
| Name | Type | Source |
|---|---|---|
| input | DTO_tenant_change_plan_input | Body |
Request body example
Response
Response body example
DTO_tenant_change_plan_input
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| plan | ENUM tenant_plan | Plan | |
| capped_amount | Double | Capped amount |
DTO_redirect
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| redirect_url | String | Redirect url |
ENUM tenant_plan
| Value | Name | Description |
|---|---|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | FREE | FREE |
| 2 | SMALL | SMALL |
| 3 | MEDIUM | MEDIUM |
| 4 | LARGE | LARGE |
Generated Aug 4, 2026 18:37