Retrieve sending settings
/account/sendingCosts 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
fromobjectShow 3 child attributesHide child attributes
emailstringExample:billing@example.comverifiedbooleanExample:truein_usebooleanExample:true
copiesobjectShow 4 child attributesHide child attributes
enabledbooleanExample:truetostringExample:a@example.com; b@example.comcustomer_metafieldstringto_addressesarray of strings
statusobjectShow 2 child attributesHide child attributes
sending_allowedbooleanExample:trueunlimited_sendingstringExample:standard
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/sending" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/account/sending", {
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/sending",
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/sending")
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){
"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"
}
}{
"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"
}