Skip to content

Update payment failed email

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

PATCH/preorders/templates/payment_failed

Costs 2 rate-limit points · Rate limits

Update the payment-failed email STOQ sends when the remaining balance of a partially paid preorder cannot be charged: its subject, heading, body, button text and optional Klaviyo flow. The body is the GET shape, email{...}; an optional body locale writes the copy in that language only (omit it for the shop default).

Deep partial: absent fields are unchanged, unknown or read-only keys are rejected. Errors are 422 keyed "template.<path>". Returns the template.

Also searched aschange payment collection email

Headers

  • Idempotency-Keystring

    A fresh unique key for every write (a new UUID, say); reuse it only to retry that write. Keys are remembered for 1 hour: the same key and the same request within that hour returns the first result, with Idempotent-Replayed: true, without running again; the same key with a different method, path or body is refused (422 idempotency_key_reused); a retry while the first is still running gets 409 idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.

Request body

  • emailobject

    Copy of the email sent when the remaining balance of a partially paid preorder cannot be charged.

    Show 5 child attributesHide child attributes
    • subjectstring

      Email subject of the payment-failed email, sent when the remaining balance of a partially paid preorder cannot be charged.

    • headingstring

      Heading at the top of the payment-failed email.

    • bodystring

      Message body of the payment-failed email.

    • button_textstring

      Text of the button that takes the customer to complete the payment.

    • klaviyo_flow_namestring

      Klaviyo flow to trigger when a preorder payment fails, instead of sending the email here. Only used while the email platform is Klaviyo.

  • localestring

    Language the translated fields are written in, such as 'fr' or 'pt-BR'. Omitted: the shop's default language. Untranslated fields ignore it.

Returns

  • keystring
    Example: payment_failed
  • localestring
    Example: en
  • emailobject
    Show 7 child attributesHide child attributes
    • subjectstring
      Example: Action needed: complete payment for order {{order.name}}
    • headingstring
      Example: Complete payment for your order
    • bodystring
      Example: Hey there! We were unable to process the remaining balanc…
    • button_textstring
      Example: Complete payment
    • klaviyo_flow_namenull
    • klaviyo_flow_verifiedboolean
      Example: false
    • integrationnull

Errors

409
idempotency_key_in_progress

An earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.

422
invalid_params

One or more fields failed the action's schema.

Any request can also fail with auth_invalid (401) or rate_limited (429).

Every error has the same shape: see Errors and the list of error codes.

PATCH/preorders/templates/payment_failed
curl -X PATCH "https://app.stoqapp.com/api/v2/external/preorders/templates/payment_failed" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": {
      "subject": "Action needed: complete payment for order {{order.name}}"
    }
  }'
Response
{
  "key": "payment_failed",
  "locale": "en",
  "email": {
    "subject": "Action needed: complete payment for order {{order.name}}",
    "heading": "Complete payment for your order",
    "body": "Hey there! We were unable to process the remaining balance payment for your preorders on order #{{order.name}}. Click the button below to complete your payment to receive your preorders.",
    "button_text": "Complete payment",
    "klaviyo_flow_name": null,
    "klaviyo_flow_verified": false,
    "integration": null
  }
}