GET/v2/organizations/{organizationId}/billing/expected-usage/{type}.csv

Get expected usage details as CSV

Retrieves a CSV file with expected usage details for an organization's billing period. Set type to choose whether the file contains usage details for seats, translations, or keys.

2 parameters
organizationIdintegerrequired
The integer identifier of the organization whose usage details you want to retrieve.
typestringrequired
The usage category to include in the CSV: `SEATS`, `TRANSLATIONS`, or `KEYS`.
Allowed:SEATSTRANSLATIONSKEYS

5 status codes
200Returns a CSV file containing usage details for each time period for the selected usage category.
400Returned when the request is invalid or `type` is not one of the supported usage categories.
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 details.
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. type must be SEATS, TRANSLATIONS, or KEYS; the organizationId path parameter must identify an existing organization.