Retrieve setup settings
/account/setupCosts 1 rate-limit point · Rate limits
The store's setup state: store name, domain, country, currency and timezone; plan name; when the app was installed and onboarding finished; which interface the store uses; and the getting-started checklist (design picked, editor opened, first document, automatic invoicing). Read-only.
Also searched assetup statusonboarding checklistis the store set upstore detailswhat is left to set upstore timezone and currency
Returns
storeobjectShow 6 child attributesHide child attributes
namestringExample:Invoice Static StoredomainstringExample:invoice-falcon-static-test-store.myshopify.comemailstringExample:nexasky@gmail.comcountry_codestringExample:INcurrencystringExample:INRtimezonestringExample:America/New_York
plan_namestringExample:ultimateinstalled_atstringExample:2026-11-10T08:35:15ZonboardedbooleanExample:falseonboarded_atstring, nullableinterfacestringExample:v3migrated_fromstring, nullablechecklistobjectShow 5 child attributesHide child attributes
dismissedbooleanExample:falsestepsobjectShow 4 child attributesHide child attributes
template_designbooleanExample:falsevisual_editorbooleanExample:falsefirst_documentbooleanExample:falseautomatic_invoicingbooleanExample:true
completed_countintegerExample:1totalintegerExample:4visual_editor_template_idinteger, nullable
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/setup" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/account/setup", {
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/setup",
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/setup")
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){
"store": {
"name": "Invoice Static Store",
"domain": "invoice-falcon-static-test-store.myshopify.com",
"email": "nexasky@gmail.com",
"country_code": "IN",
"currency": "INR",
"timezone": "America/New_York"
},
"plan_name": "ultimate",
"installed_at": "2026-11-10T08:35:15Z",
"onboarded": false,
"onboarded_at": null,
"interface": "v3",
"migrated_from": null,
"checklist": {
"dismissed": false,
"steps": {
"template_design": false,
"visual_editor": false,
"first_document": false,
"automatic_invoicing": true
},
"completed_count": 1,
"total": 4,
"visual_editor_template_id": null
}
}{
"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"
}