Get Organization Credits

Retrieve the current credit balance for your main organization, including total, used, and remaining credits. This endpoint is useful for monitoring usage and ensuring your organization stays within its credit limits.

Request

• Method: GET
• URL: {{host}}/api/v2/organizations/credits
• Authentication: Requires a valid user-token variable set in your environment. The host variable must also be defined.
• Request Body: None

Response

A successful response returns a JSON object with the following structure:

{
  "total_credits": 10000,
  "used_credits": 2500,
  "remaining_credits": 7500
}

Error Response Example

If authentication fails or required variables are missing, you may receive an error response such as:

{
  "error": "Unauthorized",
  "message": "Missing or invalid user-token."
}

Usage Notes

• Ensure both host and user-token variables are set in your environment before sending the request.
• This endpoint does not require any parameters or a request body.
• The response values are numeric and represent your organization's credit status.