Retrieve plan
/account/planCosts 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
tierstringExample:proplan_namestringExample:ultimateprice_per_monthstringExample:9.99paidbooleanExample:trueis_partnerbooleanExample:trueusageobjectShow 6 child attributesHide child attributes
orders_invoiced_this_cycleintegerExample:1monthly_limitintegerExample:50remainingintegerExample:49countedstringExample:An order counts once per cycle when one of its documents …cycle_started_onstringExample:2026-11-10cycle_resets_onstringExample:2026-12-10
Errors
Missing or unknown X-Auth-Token, or the shop uninstalled the app.
v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.
The request failed validation. Nothing was saved.
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.
curl "https://app.invoicefalcon.com/api/v3/external/account/plan" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/account/plan", {
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.invoicefalcon.com/api/v3/external/account/plan",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/account/plan")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"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"
}
}{
"errors": [
"Invalid API key"
],
"code": "unauthorized"
}{
"errors": [
"API access requires a paid plan"
],
"code": "paid_plan_required"
}{
"errors": [
"id is missing"
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited"
}