Skip to main content
Matchers define which orders in the schedule should be affected by an adjustment.

​
Cycle

Match orders by billing cycle number.
Use cases:
  • Target a specific future order (e.g., “skip the 3rd order”)
  • Apply adjustment to a known cycle
Input:
FieldTypeRequiredDescription
cycleintegerYesTarget cycle number (0-indexed)
{
  "type": "CYCLE",
  "input": {
    "cycle": 3
  }
}
Cycle numbers start at 0. Cycle 0 is the first/current cycle.

​
Date

Match orders by their scheduled date.
Use cases:
  • Skip all orders on a specific date (e.g., holiday)
  • Target orders regardless of cycle number
Input:
FieldTypeRequiredDescription
datestringYesTarget date (ISO 8601)
{
  "type": "DATE",
  "input": {
    "date": "2025-01-01T00:00:00Z"
  }
}

​
Cycle and date

Match orders by both cycle number and scheduled date.
Use cases:
  • Precise targeting when both cycle and date matter
  • Disambiguate when multiple orders could match
Input:
FieldTypeRequiredDescription
cycleintegerYesTarget cycle number (0-indexed)
datestringYesTarget date (ISO 8601)
{
  "type": "CYCLE_AND_DATE",
  "input": {
    "cycle": 2,
    "date": "2025-03-15T00:00:00Z"
  }
}

​
Compatibility

Not all matchers work with all actions:
ActionCYCLEDATECYCLE_AND_DATE
SKIP_ORDER✓✓✓
CHANGE_DATE✓✗✗
UPDATE_SHIPPING✓✓✓
UPDATE_PAYMENT_METHOD✓✓✓
UPDATE_PRODUCTS✓✓✓