GET/v2/organizations/{organizationId}/billing/invoices/{invoiceId}/usage/{type}.csv

Get invoice usage details as CSV

Retrieves usage details for an invoice as a CSV file. Select the organization and invoice with organizationId and invoiceId, then choose the usage category with type.

3 parameters
organizationIdintegerrequired
The integer identifier of the organization that owns the invoice.
invoiceIdintegerrequired
The integer identifier of the invoice whose usage details 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.
400Returned when the request is invalid, including when `type` is not an accepted value.
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 authentication is missing or 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
403Returned when the authenticated user is not permitted to access 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 organization or invoice 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 an authentication failure, a 403 indicates insufficient access, and a 404 indicates the organization or invoice was not found. The organizationId and invoiceId path parameters must identify an invoice associated with that organization. type must be SEATS, TRANSLATIONS, or KEYS.