Get Remaining Credits

FreshGET

GET https://api.creatify.ai/api/remaining_credits/

Check the remaining credit balance for your workspace. Credits are consumed by various API operations at different rates.

Headers

Header	Type	Required	Description
X-API-ID	string	Yes	Your Creatify API ID
X-API-KEY	string	Yes	Your Creatify API key

Example Request

curl -X GET 'https://api.creatify.ai/api/remaining_credits/' \
  -H 'X-API-ID: your-api-id' \
  -H 'X-API-KEY: your-api-key'

Response

{
  "remaining_credits": 450,
  "plan": "Professional",
  "credits_reset_at": "2024-02-01T00:00:00Z"
}

Response Fields

Field	Type	Description
remaining_credits	integer	Number of credits remaining
plan	string	Current subscription plan
credits_reset_at	string	ISO 8601 timestamp for when credits reset

Status Codes

Code	Description
200	Success
401	Unauthorized -- invalid API credentials
500	Internal server error

TIP

Check your credit balance before running large batch operations. Each API operation has a different credit cost -- see the API Reference overview for a complete credit cost table.

WARNING

When credits reach zero, API calls that consume credits will return 402 Insufficient Credits. Monitor your balance proactively to avoid disruptions.