PUT/v2/organizations/{organizationId}/billing/cancel-scheduled-downgrade

Cancel a scheduled word-plan downgrade

Cancels a scheduled downgrade to an organization's word plan. Use this operation when the organization wants to keep its current plan instead of applying the scheduled downgrade.

1 parameter
organizationIdintegerrequired
The integer identifier of the organization whose scheduled downgrade you want to cancel.

5 status codes
200Returns the updated subscription details, including the organization's plan, billing period, currency, and scheduled-change information.
autoUpgradeEnabledbooleanrequired
boostEndsAtintegeroptional
cancelAtPeriodEndbooleanrequired
createdAtintegerrequired
currencystringrequired
Allowed:EURUSD
currentBillingPeriodstringoptional
Allowed:MONTHLYYEARLY
currentPeriodEndintegeroptional
currentPeriodStartintegeroptional
estimatedCostsnumberoptional
organizationIdintegerrequired
pendingWordTierUpgradeobjectoptional
pendingWordTierUpgradeAtintegeroptional
planobjectrequired
planMigrationobjectoptional
scheduledDowngradeobjectoptional
statusstringrequired
Allowed:ACTIVECANCELEDPAST_DUEUNPAIDERRORTRIALINGKEY_USED_BY_ANOTHER_INSTANCEUNKNOWN
trialEndintegeroptional
400Returned when the request is invalid.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is not authenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user does not have permission to manage the organization's subscription.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the specified organization does not exist.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 indicates an invalid request, a 401 indicates missing or invalid authentication, a 403 indicates insufficient access, and a 404 indicates the organization was not found. The organizationId path parameter must identify an existing organization with billing details accessible to the authenticated user.