Skip to content

Retrieve integration settings

GET/account/integrations

Costs 1 rate-limit point · Rate limits

What the store has connected: whether an API key exists (never the key itself), the payment processor used for pay-now links and its mode, and the per-language texts of the Customer Accounts invoice download widget. Read-only.

Also searched asintegrationsis stripe connecteddo I have an API keycustomer accounts translationspayment processor settingsconnected apps

Returns

  • api_keyobject
    Show 2 child attributesHide child attributes
    • configuredboolean
      Example: true
    • keystring
  • payment_processorobject
    Show 3 child attributesHide child attributes
    • connectedboolean
      Example: false
    • namestring, nullable
    • stripe_checkout_v2boolean
      Example: false
  • customer_accountsobject
    Show 1 child attributeHide child attributes
    • translationsarray of anys

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/integrations
curl "https://app.invoicefalcon.com/api/v3/external/account/integrations" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
Response
{
  "api_key": {
    "configured": true
  },
  "payment_processor": {
    "connected": false,
    "name": null,
    "stripe_checkout_v2": false
  },
  "customer_accounts": {
    "translations": []
  }
}