Skip to main content
This endpoint returns a snapshot of your account’s current plan, compression usage, and AI credit balances. Use it to check whether you have remaining capacity before submitting a batch, or to surface usage data in your own tooling.

Request

Method: GET
URL: https://fluximage.app/api/usage
Authorization: Bearer flx_live_your_key_here
No request body is required.

Example request

Response

200 OK

For Pro and Agency plans, compressor_limit returns a large number indicating effectively unlimited compressions. Use canCompress as the authoritative check for whether you can compress in the current period.

Response fields

string
Your current subscription plan. Possible values: free, starter, pro, agency.
number
Number of images you have compressed in the current billing period.
number
Maximum images you can compress per billing period on your current plan.
number
Number of AI credits consumed from your monthly allocation in the current billing period.
number
Total AI credits included in your plan each month. 0 on the free plan.
number
Additional AI credits you have purchased as top-ups. These are consumed after your monthly allocation is exhausted.
number
Total AI credits still available, combining remaining monthly credits and top-up credits: (ia_credits_monthly − ia_credits_used) + ia_topup_credits.
boolean
true if you have remaining compression capacity for the current billing period.
boolean
true if you are on a paid plan and have at least one AI credit remaining.
object
Contains keys small, medium, and large corresponding to the three AI credit top-up bundles available for purchase. You can use these values to initiate a checkout session for the desired pack size.

Error codes