Tolgee Octri Demo
GET/v2/organizations/{organizationId}/billing/expected-usage

Get expected usage for the current month

Retrieves expected usage for an organization's current billing month. Use the usage totals for keys, seats, and translations to review consumption against plan allowances and estimated costs.

1 parameter
organizationIdintegerrequired
The integer identifier of the organization whose expected usage you want to retrieve.

5 status codes
200Returns expected usage totals for keys, seats, and translations, including used, unused, and over-plan quantities, along with the total and any available cost or credit details.
appliedStripeCreditsnumberoptional
Relevant for invoices only. When there are applied stripe credits, we need to reduce the total price by this amount.
carryOverTotalnumberoptional
Relevant for invoices only. Total amount deferred from previous billing periods that is included in this invoice.
creditsobjectoptional
keysobjectrequired
seatsobjectrequired
subscriptionPricenumberoptional
totalnumberrequired
translationsobjectrequired
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 access the organization's usage.
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 whose billing usage the authenticated user can access.