Check Credits

Returns the current message allowance and usage for the user that owns the API key: monthly allowance, credits used this period, and remaining credits.

Endpoint

MethodPath
GET/account/check_credits

Request

Method: GET. Header: Api-Key (required). Body: None.

Replace YOUR_UPSCALE_API_KEY with a real API key from the configurator.

Example request

curl -X GET "https://app.upscaleoutreach.com/account/check_credits" \
  -H "Api-Key: YOUR_UPSCALE_API_KEY"

Response

Success (200 OK): JSON with message_allowance, credits_used, remaining_credits.

Response fields (200 OK)

See table below. Error (401): missing, invalid, or revoked key returns the same error shape. See tabs for example bodies.

Success (200 OK)

{
  "message_allowance": 900,
  "credits_used": 120,
  "remaining_credits": 780
}

Response fields (200 OK)

FieldTypeDescription
message_allowanceintegerTotal monthly credits for the user (from plan/role).
credits_usedintegerCredits used in the current billing/usage period.
remaining_creditsintegermessage_allowance - credits_used, minimum 0.