Skip to content

Update automation settings

PATCH/account/automation

Costs 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_invoicesobject
    Show 8 child attributesHide child attributes
    • enabledboolean

      Email an invoice for every order that meets the condition.

    • delay_minutesinteger, nullable

      Wait this long after the order before sending (1-30); null sends at once.

    • whenobject
      Show 4 child attributesHide child attributes
      • triggerstring

        Which condition applies. any_order clears the three statuses; the others need the matching status set.

        One of any_orderpayment_statusfulfillment_statusshipment_status
      • payment_statusstring, nullable

        Send when the order reaches this payment status. Clears the other two.

        One of paidpendingrefundedpartially_paidauthorizedvoided
      • fulfillment_statusstring, nullable

        Send when the order reaches this fulfillment status. Clears the other two.

        One of shippedunshippedpartialin_progresson_hold
      • shipment_statusstring, nullable

        Send when the shipment reaches this status. Clears the other two.

        One of shippeddeliveredin_transit
    • only_customer_tagsstring, nullable

      Only customers with one of these tags (comma-separated).

    • except_customer_tagsstring, nullable

      Never for customers with one of these tags.

    • only_order_tagsstring, nullable

      Only orders with one of these tags.

    • except_order_tagsstring, nullable

      Never for orders with one of these tags.

    • only_sales_channelsstring, nullable

      Only orders from these sales channels (comma-separated Shopify source names such as web, pos, amazon); blank means any.

  • automatic_credit_notesobject
    Show 2 child attributesHide child attributes
    • enabledboolean

      Create a credit note when Shopify records a refund.

    • email_customerboolean

      Also email the credit note to the customer.

  • pay_now_buttonobject
    Show 1 child attributeHide child attributes
    • enabledboolean

      Show a Pay now button in invoice emails for unpaid orders.

  • payment_remindersobject
    Show 8 child attributesHide child attributes
    • enabledboolean

      Payment reminders are available for unpaid invoices.

    • automaticboolean

      Send reminders automatically instead of by hand.

    • due_after_daysinteger, nullable

      Days after the invoice date an invoice is due.

    • every_daysinteger

      Days between reminders (at least 1).

    • sendstring

      Before the due date, after it, or both.

      One of afterbeforeboth
    • also_send_tostring, nullable

      Extra recipients, comma-separated.

    • only_to_these_addressesboolean

      Send reminders only to also_send_to, not the customer.

    • include_payment_linkboolean

      Put the payment link in reminder emails.

Returns

  • automatic_invoicesobject
    Show 7 child attributesHide child attributes
    • enabledboolean
      Example: true
    • delay_minutesinteger, nullable
      Example: 5
    • whenobject
      Show 4 child attributesHide child attributes
      • payment_statusstring
        Example: paid
      • fulfillment_statusstring, nullable
      • shipment_statusstring, nullable
      • triggerstring
        Example: payment_status
    • only_customer_tagsstring, nullable
    • except_customer_tagsstring, nullable
    • only_order_tagsstring, nullable
    • except_order_tagsstring, nullable
  • automatic_credit_notesobject
    Show 2 child attributesHide child attributes
    • enabledboolean
      Example: false
    • email_customerboolean
      Example: false
  • pay_now_buttonobject
    Show 1 child attributeHide child attributes
    • enabledboolean
      Example: false
  • payment_remindersobject
    Show 10 child attributesHide child attributes
    • enabledboolean
      Example: true
    • automaticboolean
      Example: false
    • due_after_daysinteger, nullable
    • every_daysinteger
      Example: 5
    • sendstring
      Example: after
    • also_send_tostring
    • only_to_these_addressesboolean
      Example: false
    • include_payment_linkboolean
      Example: false
    • activeboolean
      Example: false
    • also_send_to_addressesarray of anys
  • paid_features_availableboolean
    Example: true

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.

PATCH/account/automation
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"
      }
    }
  }'
Response
{
  "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
}