Skip to main content
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:
FieldTypeRequiredDescription
reasonstringYesReason for skipping the order
{
  "type": "SKIP_ORDER",
  "input": {
    "reason": "Customer on vacation"
  }
}

​
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:
FieldTypeRequiredDescription
newDatestringYesNew 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:
FieldTypeRequiredDescription
address.firstNamestringNoFirst name
address.lastNamestringNoLast name
address.address1stringYesStreet address line 1
address.address2stringNoStreet address line 2
address.citystringNoCity
address.zipstringNoPostal/ZIP code
address.countryCodestringYesISO country code
address.provinceCodestringNoProvince/state code
address.phonestringNoPhone number
address.companystringNoCompany 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:
FieldTypeRequiredDescription
paymentMethodIdstringYesPayment 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:
FieldTypeRequiredDescription
linesarrayYesArray of line modifications (min 1)
lines[].lineIdstringYesID of the line to modify
lines[].variantIdstringNoNew variant ID to swap to
lines[].quantityintegerNoNew quantity (min 1)
lines[].intervalobjectNoOverride billing interval
lines[].interval.intervalCountintegerNoNumber of intervals
lines[].interval.intervalstringNoInterval unit: DAY, WEEK, MONTH, YEAR
lines[].nextBillingDatestringNoOverride next billing date (ISO 8601)
{
  "type": "UPDATE_PRODUCTS",
  "input": {
    "lines": [
      {
        "lineId": "line_abc123",
        "quantity": 2
      },
      {
        "lineId": "line_def456",
        "variantId": "variant_xyz789"
      }
    ]
  }
}
Line IDs must exist in the customer’s subscriptions.