GET/v2/organizations/{organizationId}/billing/subscription

Get an organization's active subscription

Retrieves the active subscription for an organization. Use the organization's identifier to view its plan, subscription status, billing period, and cost details.

1 parameter
organizationIdintegerrequired
The integer identifier of the organization whose subscription to retrieve.

5 status codes
200Returns the active subscription details, including its plan, status, currency, billing period, and cost 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 access to the requested resource.
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 requested organization or subscription is not found.
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, and a 403 indicates the authenticated user lacks access. A 404 indicates the organization or subscription was not found; the organizationId path parameter must be an integer.