Skip to content

Retrieve sending settings

GET/account/sending

Costs 1 rate-limit point · Rate limits

How the store sends email: the custom "from" address and whether its domain is verified (and therefore in use), who gets a copy of every invoice email (a BCC list and an optional customer metafield holding extra recipients), and whether sending is currently allowed. Read-only.

status.unlimited_sending values: standard (Standard limits), pending (Unlimited sending requested), approved (Unlimited sending approved).

Also searched asemail sender settingswhat address do my invoices come fromis my sending domain verifiedbcc settingswho gets copies of invoice emailscan I send emails

Returns

  • fromobject
    Show 3 child attributesHide child attributes
    • emailstring
      Example: billing@example.com
    • verifiedboolean
      Example: true
    • in_useboolean
      Example: true
  • copiesobject
    Show 4 child attributesHide child attributes
    • enabledboolean
      Example: true
    • tostring
      Example: a@example.com; b@example.com
    • customer_metafieldstring
    • to_addressesarray of strings
  • statusobject
    Show 2 child attributesHide child attributes
    • sending_allowedboolean
      Example: true
    • unlimited_sendingstring
      Example: standard

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/sending
curl "https://app.invoicefalcon.com/api/v3/external/account/sending" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
Response
{
  "from": {
    "email": "billing@example.com",
    "verified": true,
    "in_use": true
  },
  "copies": {
    "enabled": true,
    "to": "a@example.com; b@example.com",
    "customer_metafield": "",
    "to_addresses": [
      "a@example.com",
      "b@example.com"
    ]
  },
  "status": {
    "sending_allowed": true,
    "unlimited_sending": "standard"
  }
}