Skip to main content
GET

Authorizations

x-api-key
string
header
required

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.

account_id
string
required
email
string | null
required
plan
enum<string>
required
Available options:
free,
pro,
enterprise
tier
integer | null
required

The Pro tier (its monthly credits); null on other plans.

interval
enum<string> | null
required
Available options:
month,
year,
null
subscription_status
string | null
required

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.

unlimited
boolean
required

True when fixes cost no credit.

credits
object
required

Credits left by kind, in the order fixes spend them (after the day's free fix).

period_credits
integer | null
required

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.

credits_used_this_period
integer
required

Plan credits spent since the last paid invoice.

Required range: x >= 0
current_period_start
string<date-time> | null
required
date-time
current_period_end
string<date-time> | null
required
date-time

When the plan renews, or ends when a cancellation is set; null off Pro.

daily_free_available
boolean
required

Whether today's free fix is still available.

daily_free_resets_at
string<date-time>
required
date-time

The next UTC midnight, when the next free fix of the day becomes available.