Skip to content

Retrieve plan

GET/account/plan

Costs 1 rate-limit point · Rate limits

The shop's Invoice Falcon plan and this billing cycle's usage: the plan name, whether it is paid, the Free plan monthly invoice limit and how many orders have been invoiced against it, and when the cycle resets. Read-only.

tier values: free (Free), pro (Pro), partner (Partner).

Also searched aswhat plan am i onplan and usagehow many invoices have i usedmonthly limitwhen does my limit resetam i on the free plan

Returns

  • tierstring
    Example: pro
  • plan_namestring
    Example: ultimate
  • price_per_monthstring
    Example: 9.99
  • paidboolean
    Example: true
  • is_partnerboolean
    Example: true
  • usageobject
    Show 6 child attributesHide child attributes
    • orders_invoiced_this_cycleinteger
      Example: 1
    • monthly_limitinteger
      Example: 50
    • remaininginteger
      Example: 49
    • countedstring
      Example: An order counts once per cycle when one of its documents …
    • cycle_started_onstring
      Example: 2026-11-10
    • cycle_resets_onstring
      Example: 2026-12-10

Errors

401

Missing or unknown X-Auth-Token, or the shop uninstalled the app.

403

v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.

422

The request failed validation. Nothing was saved.

429

Rate limited: cost-weighted per key (reads cost less than writes). Wait Retry-After seconds; see X-RateLimit-* headers.

Every error has the same shape: see Errors.

GET/account/plan
curl "https://app.invoicefalcon.com/api/v3/external/account/plan" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
Response
{
  "tier": "pro",
  "plan_name": "ultimate",
  "price_per_month": "9.99",
  "paid": true,
  "is_partner": true,
  "usage": {
    "orders_invoiced_this_cycle": 1,
    "monthly_limit": 50,
    "remaining": 49,
    "counted": "An order counts once per cycle when one of its documents is emailed, printed, downloaded or rendered; creating or listing invoices does not.",
    "cycle_started_on": "2026-11-10",
    "cycle_resets_on": "2026-12-10"
  }
}