Retrieve the plan and credits of the account behind a key
The plan, tier and credits left of the account behind your API key, and whether its free fix of the day is still available. Costs nothing to call.
Authorizations
An API key of your account, created on makeseamless.com and sent in the x-api-key header. Keys start with smls_. On the Free plan, the images of a fix started with a key carry a watermark; on Pro they are clean.
Response
The account of the API key.
free, pro, enterprise The Pro tier (its monthly credits); null on other plans.
month, year, null The subscription's status: active, past_due, cancelled, incomplete, expired, unpaid or paused; null without one. The plan is Pro while it is active or past_due.
True when fixes cost no credit.
Credits left by kind, in the order fixes spend them (after the day's free fix).
The plan's allowance; for a monthly plan the plan credits each paid invoice sets, for a yearly plan the year's credits as written (plan credits left plus used this period, so credits an upgrade carried in count); null off Pro.
Plan credits spent since the last paid invoice.
x >= 0When the plan renews, or ends when a cancellation is set; null off Pro.
Whether today's free fix is still available.
The next UTC midnight, when the next free fix of the day becomes available.