Actions

Actions define what modification to apply when a schedule adjustment matches an order.

Skip order

Prevents an order from being created. The order will be excluded from the schedule entirely.

Use cases:

Customer going on vacation
Holiday closures
Temporary subscription pause

Input:

Field	Type	Required	Description
`reason`	string	Yes	Reason for skipping the order

{
  "type": "SKIP_ORDER",
  "input": {
    "reason": "Customer on vacation"
  }
}

Skip item

Removes individual line items from an order while leaving the rest of the order intact.

Use cases:

Customer already has enough of one product
Skipping a single product in a multi-product subscription
Pausing one item without pausing the whole subscription

Input:

Field	Type	Required	Description
`lineIds`	array	Yes	Subscription line IDs to skip from the order (min 1)
`reason`	string	No	Reason for skipping the item(s)

{
  "type": "SKIP_ITEM",
  "input": {
    "lineIds": ["line_abc123", "line_def456"],
    "reason": "Customer has enough coffee"
  }
}

Skipped items remain in the response with skipped: true rather than being removed, so you can show the customer what was skipped. Pass excludeSkipped=true on Get schedule to omit them instead.

Skipping an item is a single-cycle skip. The item’s nextBillingDate still advances, so the next order in the schedule is unaffected — but the skipped cycle does not count towards the item’s usage count.

If lineIds covers every line in the order, the whole order is skipped — the result is equivalent to SKIP_ORDER, and the order is returned with skipped: true.

Discounts are recalculated against the remaining items. A discount whose entitled lines were all skipped no longer applies and is dropped from the order, and an order left with no shippable lines carries no delivery price.

Change date

Reschedules an order to a different date within the billing period.

Use cases:

Customer requests different delivery day
Adjusting timing around events

Input:

Field	Type	Required	Description
`newDate`	string	Yes	New date for the order (ISO 8601)

{
  "type": "CHANGE_DATE",
  "input": {
    "newDate": "2025-02-15T00:00:00Z"
  }
}

Only supports the CYCLE matcher. The new date must be within one billing cycle of the original date and cannot be in the past.

Update shipping

Updates the shipping address for a specific order.

Use cases:

Customer temporarily at different address
One-time delivery to alternate location

Input:

Field	Type	Required	Description
`address.firstName`	string	No	First name
`address.lastName`	string	No	Last name
`address.address1`	string	Yes	Street address line 1
`address.address2`	string	No	Street address line 2
`address.city`	string	No	City
`address.zip`	string	No	Postal/ZIP code
`address.countryCode`	string	Yes	ISO country code
`address.provinceCode`	string	No	Province/state code
`address.phone`	string	No	Phone number
`address.company`	string	No	Company name

{
  "type": "UPDATE_SHIPPING",
  "input": {
    "address": {
      "firstName": "John",
      "lastName": "Doe",
      "address1": "123 Main St",
      "city": "New York",
      "countryCode": "US",
      "zip": "10001"
    }
  }
}

Address must include at least address1 and countryCode.

Update payment method

Updates the payment method for a specific order.

Use cases:

Use different card for specific order
One-time payment method override

Input:

Field	Type	Required	Description
`paymentMethodId`	string	Yes	Payment method identifier

{
  "type": "UPDATE_PAYMENT_METHOD",
  "input": {
    "paymentMethodId": "pm_abc123"
  }
}

Update products

Modifies product lines for a specific order.

Use cases:

One-time quantity change
Swap variant for single order
Adjust billing interval for specific cycle

Input:

Field	Type	Required	Description
`lines`	array	Yes	Array of line modifications (min 1)
`lines[].lineId`	string	Yes	ID of the line to modify
`lines[].variantId`	string	No	New variant ID to swap to
`lines[].quantity`	integer	No	New quantity (min 1)
`lines[].interval`	object	No	Override billing interval
`lines[].interval.intervalCount`	integer	No	Number of intervals
`lines[].interval.interval`	string	No	Interval unit: DAY, WEEK, MONTH, YEAR
`lines[].nextBillingDate`	string	No	Override next billing date (ISO 8601)
`lines[].customAttributes`	array	No	Custom attributes to merge onto the order item
`lines[].customAttributes[].key`	string	Yes	Attribute key
`lines[].customAttributes[].value`	string	Yes	Attribute value

{
  "type": "UPDATE_PRODUCTS",
  "input": {
    "lines": [
      {
        "lineId": "line_abc123",
        "quantity": 2
      },
      {
        "lineId": "line_def456",
        "variantId": "variant_xyz789"
      },
      {
        "lineId": "line_ghi789",
        "customAttributes": [
          { "key": "gift_message", "value": "Happy birthday!" }
        ]
      }
    ]
  }
}

Line IDs must exist in the customer’s subscriptions. Attributes are merged onto the item by key — existing keys are overwritten, unspecified keys are preserved.

Reserved/internal attribute keys cannot be set via customAttributes and will cause the request to fail with a 400 error.

Apply discount

Applies a discount (Shopify code or manual) to a specific order in the schedule.

Use cases:

One-time promotional discount for specific cycle
Loyalty reward for long-term subscribers
Compensation discount for service issues

The action supports two discount sources: Shopify discount codes and manual discounts.

Shopify code discount

Apply an existing Shopify discount code to the order. Input:

Field	Type	Required	Description
`discountSource`	string	Yes	Must be `"code"`
`discountCode`	string	Yes	The Shopify discount code to apply

{
  "type": "APPLY_DISCOUNT",
  "input": {
    "discountSource": "code",
    "discountCode": "SAVE20"
  }
}

Discount code must exist in Shopify, be active, and apply to subscriptions. Only basic discounts and free shipping discounts are supported.

Manual discount - line items

Create a custom discount targeting line items. Input:

Field	Type	Required	Description
`discountSource`	string	Yes	Must be `"manual"`
`discountCode`	string	Yes	Custom discount title/name
`discountType`	string	Yes	`"percentage"` or `"fixed_amount"`
`value`	number	Yes	Discount value (percentage 0-100 or fixed amount in shop currency)
`targetType`	string	Yes	Must be `"line_item"`
`targeting`	object	Yes	Specifies what to target

Targeting options:

{ "type": "all" } - Apply to all line items
{ "type": "products", "productIds": ["gid://shopify/Product/123", ...] } - Apply to specific products

Example: Percentage discount on all items

{
  "type": "APPLY_DISCOUNT",
  "input": {
    "discountSource": "manual",
    "discountCode": "Loyalty Reward",
    "discountType": "percentage",
    "value": 15,
    "targetType": "line_item",
    "targeting": {
      "type": "all"
    }
  }
}

Example: Fixed amount discount on specific products

{
  "type": "APPLY_DISCOUNT",
  "input": {
    "discountSource": "manual",
    "discountCode": "Product Promo",
    "discountType": "fixed_amount",
    "value": 10,
    "targetType": "line_item",
    "targeting": {
      "type": "products",
      "productIds": ["gid://shopify/Product/123456789"]
    }
  }
}

Manual discount - shipping

Create a custom discount targeting shipping. Input:

Field	Type	Required	Description
`discountSource`	string	Yes	Must be `"manual"`
`discountCode`	string	Yes	Custom discount title/name
`discountType`	string	Yes	Must be `"percentage"`
`value`	number	Yes	Must be `100` (free shipping)
`targetType`	string	Yes	Must be `"shipping"`
`targeting`	object	Yes	Must be `{ "type": "all" }`

Example: Free shipping discount

{
  "type": "APPLY_DISCOUNT",
  "input": {
    "discountSource": "manual",
    "discountCode": "Free Shipping",
    "discountType": "percentage",
    "value": 100,
    "targetType": "shipping",
    "targeting": {
      "type": "all"
    }
  }
}

Only supports the CYCLE matcher. Only supports free shipping discounts (100% off) - partial shipping discounts and fixed amount shipping discounts are not supported.

Core Resources

Webhooks

Skip order

Skip item

Change date

Update shipping

Update payment method

Update products

Apply discount

Shopify code discount

Manual discount - line items

Manual discount - shipping

​Skip order

​Skip item

​Change date

​Update shipping

​Update payment method

​Update products

​Apply discount

​Shopify code discount

​Manual discount - line items

​Manual discount - shipping

Skip order

Skip item

Change date

Update shipping

Update payment method

Update products

Apply discount

Shopify code discount

Manual discount - line items

Manual discount - shipping