View Categories

Launching soon on the Shopify App StoreAbout Subscriptions & MembershipsJoin the waitlist

Emails, Shopify Flow and the API

3 min read

The app emails customers at each step of a subscription, a membership and a rental queue loan, and sends your staff a copy of the ones that need a look. You choose which emails go out and can change their wording. For automations, the app adds triggers and actions to Shopify Flow, and developers can use its REST and GraphQL API.

The emails #

Open Settings › Emails. Under Which emails to send, each switch covers one group:

SwitchEmails
Welcome (with the link to manage the subscription)Welcome
Upcoming chargeUpcoming charge, a few days before a renewal (the days are set in Settings › General › Renewals)
Trial endingTrial ending
Payment failed and out of stockPayment failed, Out of stock
Payment needs confirming (3-D Secure)Payment needs confirming
Paused, resumed, cancelled, endedPaused, Resumed, Cancelled, Ended (all cycles billed)
Card expiringCard expiring
Membership started, payment problem, endedMembership started, Membership payment problem, Membership ended
Store credit added (each billing period)Store credit added (off by default)
Rental queue: item sent, returned, return reminder, queue low, item not returnedQueue: item on its way, Queue: item returned, Queue: return reminder, Queue: running low, Queue: item marked lost

The gift email (Gift received, to the recipient) always goes out for a gift subscription. See Prepaid plans, a set billing day and gifts.

Staff copies #

Staff copies go to: “Email addresses, separated by commas. Empty: your store’s email.” Staff get Staff: payment failed and Staff: cancelled.

Change the wording #

Under Wording, pick an email and change its Subject, Heading and Message. “Plain text. A blank line starts a new paragraph.” Merge tags fill in the details, for example:

  • {customer_first_name}, {shop_name}, {items}, {amount}, {charge_date}, {trial_end};
  • {portal_link}: the link to manage the subscription;
  • {card}, {card_expiry}, {reason};
  • {tier_name}, {membership_end}, {grace_until}, {credit_amount}, {credit_expiry}, {members_link};
  • {item}, {serial}, {sent_date}, {due_back}, {returned_date}, {queue_count}, {queue_link}, {lost_note}.

Each email lists the tags it takes. Use our wording puts the original text back. Send a test sends it to an address you enter.

The delivery log #

The Delivery log lists every email with its Status: Queued, Sent, Failed or Skipped. Retry sends a failed one again.

Where the emails come from (your store name through our mail service, your own domain or your own mail server) is set on the Email sending page, shared by all your Sales Igniter apps on the store.

Shopify Flow #

Triggers #

TriggerWhen
Subscription startedIts first order was placed, or its free trial began.
Subscription renewedA renewal charge went through and its order was created.
Subscription payment failedA renewal charge failed; retries are scheduled.
Subscription pausedBy the customer, staff, Flow, or after failed payments.
Subscription cancelledAt once, or when a scheduled cancellation took effect.
Subscription endedAfter its last billing cycle.
Membership startedA customer became a member.
Membership endedA membership ended.
Membership store credit grantedA billing period’s store credit was added.
Rental queue item sentAn item from a member’s rental queue was sent.
Rental queue item returnedA borrowed item came back.
Rental queue item lostA borrowed item was marked lost.
Rental queue running lowA member’s queue dropped below the queue-low setting.

The subscription triggers carry the customer, the subscription and contract IDs, the status and previous status, the plan name, the billing interval, the next billing date, the cycles billed, the amount and currency, the first order, who changed it, the cancel reason and a link to the subscription in the app.

Actions #

ActionWhat it does
Pause subscriptionFor a number of billing cycles, or until it is resumed.
Skip next subscription chargeSkips the next charge; the one after it is billed as usual.
Cancel subscriptionAt the end of its paid period, or now.
Grant membership store creditAdds store credit to a member’s account, recorded on their membership.
Add to rental queueAdds a product, or one of its options, to a member’s queue.
Send next rental queue itemSends the member the next item in stock, as the pick list would.

For example: when Subscription payment failed fires, tag the customer and send your team a message; when Membership started fires, add the customer to a marketing list.

The API #

The REST API (under /api/v1/subs/) and the GraphQL API reach your subscriptions and plans:

  • subscriptions: list, filter and read them; pause, resume, cancel, skip the next charge, bill now, change the plan, swap the product and add items to the next order;
  • plans: read them;
  • memberships and tiers: add and end memberships, adjust store credit;
  • the rental queue and loans: add, move and send items, returns and lost items;
  • gifts, analytics and the retention report.

The API uses your store’s secret API key, the same keys as our other apps. This app has no key page of its own: create the key in another Sales Igniter app on the store (Settings › API in Rentals & Bookings or SI Delivery Routing, API access in E-Sign Contracts & Waivers, Custom Fields or SI Request a Quote). For keys, addresses and errors, see API overview: keys, versions, limits and errors.

Good to know #

  • Emails are in English for now.
  • Changes made through Flow or the API show in the subscription’s Activity, marked “by Shopify Flow” or “by the API”.