Skip to content

Retrieve setup settings

GET/account/setup

Costs 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

  • storeobject
    Show 6 child attributesHide child attributes
    • namestring
      Example: Invoice Static Store
    • domainstring
      Example: invoice-falcon-static-test-store.myshopify.com
    • emailstring
      Example: nexasky@gmail.com
    • country_codestring
      Example: IN
    • currencystring
      Example: INR
    • timezonestring
      Example: America/New_York
  • plan_namestring
    Example: ultimate
  • installed_atstring
    Example: 2026-11-10T08:35:15Z
  • onboardedboolean
    Example: false
  • onboarded_atstring, nullable
  • interfacestring
    Example: v3
  • migrated_fromstring, nullable
  • checklistobject
    Show 5 child attributesHide child attributes
    • dismissedboolean
      Example: false
    • stepsobject
      Show 4 child attributesHide child attributes
      • template_designboolean
        Example: false
      • visual_editorboolean
        Example: false
      • first_documentboolean
        Example: false
      • automatic_invoicingboolean
        Example: true
    • completed_countinteger
      Example: 1
    • totalinteger
      Example: 4
    • visual_editor_template_idinteger, nullable

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/setup
curl "https://app.invoicefalcon.com/api/v3/external/account/setup" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
Response
{
  "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
  }
}