- 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.Return created
Return created
Runs when a return is created inside Supercycle.
| Property | Description |
|---|---|
customer.id | Shopify customer ID |
returnOrder.receivalStatus | Status: pending, received, overdue |
returnOrder.formattedId | Display ID (e.g #1001) |
returnOrder.rentals | Array of rentals |
rentals[].id | Rental global ID |
rentals[].formattedId | Display ID (e.g #1001) |
rentals[].lineItemId | Shopify line item ID |
rentals[].orderId | Shopify order ID |
rentals[].subscriptionId | Subscription ID (if exists) |
rentals[].fulfilledAt | ISO 8601 date |
rentals[].receivedAt | ISO 8601 date |
Return updated
Return updated
Runs when a return is updated inside Supercycle.
| Property | Description |
|---|---|
customer.id | Shopify customer ID |
returnOrder.receivalStatus | Status: pending, received, overdue |
returnOrder.formattedId | Display ID (e.g #1001) |
returnOrder.rentals | Array of rentals |
rentals[].id | Rental global ID |
rentals[].formattedId | Display ID (e.g #1001) |
rentals[].lineItemId | Shopify line item ID |
rentals[].orderId | Shopify order ID |
rentals[].subscriptionId | Subscription ID (if exists) |
rentals[].fulfilledAt | ISO 8601 date |
rentals[].receivedAt | ISO 8601 date |
Dunning payment failed
Dunning payment failed
Runs when a dunning process completes without successfully capturing payment.
| Property | Description |
|---|---|
customer.id | Shopify customer ID |
dunning.id | Dunning global ID |
dunning.chargeableId | Object being charged |
dunning.subscriptionContractId | Shopify subscription contract ID |
dunning.failedPaymentCount | Number of failed attempts |
Available actions
Supercycle provides actions you can use in automations.Create charge
Create charge
Create a charge for a chargeable object in Supercycle, such as a rental or membership.
| Property | Description |
|---|---|
customer.id | Shopify customer ID |
chargeableId | The ID of the object to charge (e.g gid://supercycle/Rental/1234567890) |
description | The message included in the charge |
amountCents | The charge amount in cents (e.g 1234 for $12.34) |
Update subscription
Update subscription
Update the status of a subscription.
| Property | Description |
|---|---|
subscriptionId | The ID of the subscription (e.g gid://supercycle/Subscription/1234567890) |
status | The status to set: active, paused, cancelled, or expired |
Get rental data
Get rental data
Get data about a rental in Supercycle. Use this action to retrieve rental information for use in conditional logic.
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:
| Property | Description |
|---|---|
rental.id | The ID of the rental (e.g gid://supercycle/Rental/1234567890) |
getRentalData.subscriptionId | Subscription ID if exists |
getRentalData.orderId | Associated order ID |
getRentalData.fulfilledAt | Fulfillment date |
getRentalData.receivedAt | Received date |
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: