Skip to main content
Automations let you connect Supercycle with other apps or workflows in Shopify Flow. You can trigger Supercycle actions automatically when specific events happen, such as a return being created or a payment failing. This enables you to build powerful workflows that respond to rental lifecycle events without manual intervention. Examples include:
  • Pause subscriptions when customers start a return
  • Create charges for late fees, damage fees, or conversion to purchase
  • Send notifications when returns are approved or received
  • Update inventory based on return status changes
  • Manage dunning for failed subscription payments

Available triggers

Supercycle includes several triggers you can use to start an automation.
Runs when a return is created inside Supercycle.
PropertyDescription
customer.idShopify customer ID
returnOrder.receivalStatusStatus: pending, received, overdue
returnOrder.formattedIdDisplay ID (e.g #1001)
returnOrder.rentalsArray of rentals
rentals[].idRental global ID
rentals[].formattedIdDisplay ID (e.g #1001)
rentals[].lineItemIdShopify line item ID
rentals[].orderIdShopify order ID
rentals[].subscriptionIdSubscription ID (if exists)
rentals[].fulfilledAtISO 8601 date
rentals[].receivedAtISO 8601 date
Runs when a return is updated inside Supercycle.
PropertyDescription
customer.idShopify customer ID
returnOrder.receivalStatusStatus: pending, received, overdue
returnOrder.formattedIdDisplay ID (e.g #1001)
returnOrder.rentalsArray of rentals
rentals[].idRental global ID
rentals[].formattedIdDisplay ID (e.g #1001)
rentals[].lineItemIdShopify line item ID
rentals[].orderIdShopify order ID
rentals[].subscriptionIdSubscription ID (if exists)
rentals[].fulfilledAtISO 8601 date
rentals[].receivedAtISO 8601 date
Runs when a dunning process completes without successfully capturing payment.
PropertyDescription
customer.idShopify customer ID
dunning.idDunning global ID
dunning.chargeableIdObject being charged
dunning.subscriptionContractIdShopify subscription contract ID
dunning.failedPaymentCountNumber of failed attempts

Available actions

Supercycle provides actions you can use in automations.
Create a charge for a chargeable object in Supercycle, such as a rental or membership.
PropertyDescription
customer.idShopify customer ID
chargeableIdThe ID of the object to charge (e.g gid://supercycle/Rental/1234567890)
descriptionThe message included in the charge
amountCentsThe charge amount in cents (e.g 1234 for $12.34)
Update the status of a subscription.
PropertyDescription
subscriptionIdThe ID of the subscription (e.g gid://supercycle/Subscription/1234567890)
statusThe status to set: active, paused, cancelled, or expired
Get data about a rental in Supercycle. Use this action to retrieve rental information for use in conditional logic.
PropertyDescription
rental.idThe ID of the rental (e.g gid://supercycle/Rental/1234567890)
getRentalData.subscriptionIdSubscription ID if exists
getRentalData.orderIdAssociated order ID
getRentalData.fulfilledAtFulfillment date
getRentalData.receivedAtReceived date
The Get rental data action retrieves detailed information about a rental for use in conditional logic. For example, to check if a rental has subscription before taking action, you could use the following steps:
1

Add Get rental data action

Add the Get rental data action:
  • Rental ID: {{rental.id}}
2

Use returned data

Access the returned data in subsequent steps:
  • {{getRentalData.subscriptionId}} - Subscription ID if exists
  • {{getRentalData.orderId}} - Associated order ID
  • {{getRentalData.fulfilledAt}} - Fulfillment date
  • {{getRentalData.receivedAt}} - Received date
3

Add conditional logic

Use the data in conditions:
getRentalData.subscriptionId is not empty