Update automation settings
/account/automationCosts 2 rate-limit points · Rate limits
Change what the store automates: automatic invoice emails and their condition (any order, a payment, fulfillment or shipment status, narrowed by customer and order tags and by sales channel), automatic credit notes on refunds, the Pay now button, and payment reminders. Deep partial. Returns the automation section as the read shows it.
Applies to orders and invoices from now on; nothing is sent for past orders. Tag and status conditions, automatic reminders, automatic credit notes and the Pay now button need a paid plan.
Also searched asturn on automatic invoicingsend invoices automatically when paidstop automatic invoicesenable payment remindersremind customers every 7 dayscreate credit notes on refundturn off the pay now buttononly invoice customers tagged wholesaleonly invoice online store ordersskip marketplace orders
Request body
automatic_invoicesobjectShow 8 child attributesHide child attributes
enabledbooleanEmail an invoice for every order that meets the condition.
delay_minutesinteger, nullableWait this long after the order before sending (1-30); null sends at once.
whenobjectShow 4 child attributesHide child attributes
triggerstringWhich condition applies.
any_orderclears the three statuses; the others need the matching status set.One ofany_orderpayment_statusfulfillment_statusshipment_statuspayment_statusstring, nullableSend when the order reaches this payment status. Clears the other two.
One ofpaidpendingrefundedpartially_paidauthorizedvoidedfulfillment_statusstring, nullableSend when the order reaches this fulfillment status. Clears the other two.
One ofshippedunshippedpartialin_progresson_holdshipment_statusstring, nullableSend when the shipment reaches this status. Clears the other two.
One ofshippeddeliveredin_transit
only_customer_tagsstring, nullableOnly customers with one of these tags (comma-separated).
except_customer_tagsstring, nullableNever for customers with one of these tags.
only_order_tagsstring, nullableOnly orders with one of these tags.
except_order_tagsstring, nullableNever for orders with one of these tags.
only_sales_channelsstring, nullableOnly orders from these sales channels (comma-separated Shopify source names such as web, pos, amazon); blank means any.
automatic_credit_notesobjectShow 2 child attributesHide child attributes
enabledbooleanCreate a credit note when Shopify records a refund.
email_customerbooleanAlso email the credit note to the customer.
pay_now_buttonobjectShow 1 child attributeHide child attributes
enabledbooleanShow a Pay now button in invoice emails for unpaid orders.
payment_remindersobjectShow 8 child attributesHide child attributes
enabledbooleanPayment reminders are available for unpaid invoices.
automaticbooleanSend reminders automatically instead of by hand.
due_after_daysinteger, nullableDays after the invoice date an invoice is due.
every_daysintegerDays between reminders (at least 1).
sendstringBefore the due date, after it, or both.
One ofafterbeforebothalso_send_tostring, nullableExtra recipients, comma-separated.
only_to_these_addressesbooleanSend reminders only to
also_send_to, not the customer.include_payment_linkbooleanPut the payment link in reminder emails.
Returns
automatic_invoicesobjectShow 7 child attributesHide child attributes
enabledbooleanExample:truedelay_minutesinteger, nullableExample:5whenobjectShow 4 child attributesHide child attributes
payment_statusstringExample:paidfulfillment_statusstring, nullableshipment_statusstring, nullabletriggerstringExample:payment_status
only_customer_tagsstring, nullableexcept_customer_tagsstring, nullableonly_order_tagsstring, nullableexcept_order_tagsstring, nullable
automatic_credit_notesobjectShow 2 child attributesHide child attributes
enabledbooleanExample:falseemail_customerbooleanExample:false
pay_now_buttonobjectShow 1 child attributeHide child attributes
enabledbooleanExample:false
payment_remindersobjectShow 10 child attributesHide child attributes
enabledbooleanExample:trueautomaticbooleanExample:falsedue_after_daysinteger, nullableevery_daysintegerExample:5sendstringExample:afteralso_send_tostringonly_to_these_addressesbooleanExample:falseinclude_payment_linkbooleanExample:falseactivebooleanExample:falsealso_send_to_addressesarray of anys
paid_features_availablebooleanExample:true
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 -X PATCH "https://app.invoicefalcon.com/api/v3/external/account/automation" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"automatic_invoices": {
"enabled": true,
"delay_minutes": 5,
"when": {
"trigger": "payment_status",
"payment_status": "paid"
}
}
}'const res = await fetch("https://app.invoicefalcon.com/api/v3/external/account/automation", {
method: "PATCH",
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"automatic_invoices": {
"enabled": true,
"delay_minutes": 5,
"when": {
"trigger": "payment_status",
"payment_status": "paid"
}
}
}),
});
const data = await res.json();import os
import requests
res = requests.patch(
"https://app.invoicefalcon.com/api/v3/external/account/automation",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
json={
"automatic_invoices": {
"enabled": True,
"delay_minutes": 5,
"when": {
"trigger": "payment_status",
"payment_status": "paid"
}
}
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/account/automation")
req = Net::HTTP::Patch.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"], "Content-Type" => "application/json")
req.body = {
automatic_invoices: {
enabled: true,
delay_minutes: 5,
when: {
trigger: "payment_status",
payment_status: "paid"
}
}
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"automatic_invoices": {
"enabled": true,
"delay_minutes": 5,
"when": {
"payment_status": "paid",
"fulfillment_status": null,
"shipment_status": null,
"trigger": "payment_status"
},
"only_customer_tags": null,
"except_customer_tags": null,
"only_order_tags": null,
"except_order_tags": null
},
"automatic_credit_notes": {
"enabled": false,
"email_customer": false
},
"pay_now_button": {
"enabled": false
},
"payment_reminders": {
"enabled": true,
"automatic": false,
"due_after_days": null,
"every_days": 5,
"send": "after",
"also_send_to": "",
"only_to_these_addresses": false,
"include_payment_link": false,
"active": false,
"also_send_to_addresses": []
},
"paid_features_available": true
}{
"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"
}