PUT
/v2/organizations/{organizationId}/billing/schedule-downgradeSchedule a word-plan downgrade
Schedules a downgrade to a word plan for an organization at the end of its billing period. Supply period and planId to specify the billing frequency and destination plan. The response includes the organization's subscription details and scheduled downgrade information.
organizationIdintegerrequired
The integer identifier of the organization whose plan downgrade to schedule.
Billing downgrade details for the plan and billing period to take effect at the end of the current billing period.
periodstringrequired
The billing period for the destination plan: `MONTHLY` or `YEARLY`.
planIdintegerrequired
The integer identifier of the plan to switch to.
200Returns the updated subscription details, including the organization, current plan, billing period, and scheduled downgrade information.
autoUpgradeEnabledbooleanrequired
boostEndsAtintegeroptional
cancelAtPeriodEndbooleanrequired
createdAtintegerrequired
currencystringrequired
currentBillingPeriodstringoptional
currentPeriodEndintegeroptional
currentPeriodStartintegeroptional
estimatedCostsnumberoptional
organizationIdintegerrequired
pendingWordTierUpgradeobjectoptional
pendingWordTierUpgradeAtintegeroptional
planobjectrequired
planMigrationobjectoptional
scheduledDowngradeobjectoptional
statusstringrequired
trialEndintegeroptional
400Returned when the request is invalid or required body fields are missing.
codestringrequired
paramsarray<object>optional
401Returned when authentication is missing or invalid.
codestringrequired
paramsarray<object>optional
403Returned when the authenticated user is not permitted to access the requested resource.
codestringrequired
paramsarray<object>optional
404Returned when the organization is not found.
codestringrequired
paramsarray<object>optional
Error handling
A 400 indicates an invalid request, a 401 indicates an authentication failure, a 403 indicates insufficient access, and a 404 indicates the organization was not found. The organizationId path parameter must identify the organization to update. The request body must include period and planId; period must be MONTHLY or YEARLY.