Create a schedule adjustment - Developer documentation

cURL

curl --request POST \
  --url https://api.juo.io/admin/v1/schedules/adjustments \
  --header 'Content-Type: application/json' \
  --header 'X-Juo-Admin-Api-Key: <api-key>' \
  --data '
{
  "customerId": "<string>",
  "matcher": {
    "input": {
      "cycle": 1
    }
  },
  "action": {
    "input": {
      "reason": "<string>"
    }
  }
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer": "<string>",
  "matcher": {
    "type": "<string>",
    "input": "<unknown>"
  },
  "action": {
    "type": "<string>",
    "input": "<unknown>"
  },
  "actor": {
    "id": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

POST

schedules

adjustments

cURL

curl --request POST \
  --url https://api.juo.io/admin/v1/schedules/adjustments \
  --header 'Content-Type: application/json' \
  --header 'X-Juo-Admin-Api-Key: <api-key>' \
  --data '
{
  "customerId": "<string>",
  "matcher": {
    "input": {
      "cycle": 1
    }
  },
  "action": {
    "input": {
      "reason": "<string>"
    }
  }
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer": "<string>",
  "matcher": {
    "type": "<string>",
    "input": "<unknown>"
  },
  "action": {
    "type": "<string>",
    "input": "<unknown>"
  },
  "actor": {
    "id": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Examples

Skip order for the third cycle with a reason.

{
  "customerId": "cus_abc123",
  "matcher": {
    "type": "CYCLE",
    "input": {
      "cycle": 3
    }
  },
  "action": {
    "type": "SKIP_ORDER",
    "input": {
      "reason": "Customer on vacation"
    }
  }
}

Reschedule order for the second cycle to a new date.

{
  "customerId": "cus_abc123",
  "matcher": {
    "type": "CYCLE",
    "input": {
      "cycle": 2
    }
  },
  "action": {
    "type": "CHANGE_DATE",
    "input": {
      "newDate": "2025-02-15T00:00:00Z"
    }
  }
}

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

Skip all orders scheduled for a specific date.

{
  "customerId": "cus_abc123",
  "matcher": {
    "type": "DATE",
    "input": {
      "date": "2025-01-01T00:00:00Z"
    }
  },
  "action": {
    "type": "SKIP_ORDER",
    "input": {
      "reason": "Holiday closure"
    }
  }
}

Update shipping address for a specific cycle.

{
  "customerId": "cus_abc123",
  "matcher": {
    "type": "CYCLE",
    "input": {
      "cycle": 3
    }
  },
  "action": {
    "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 for a specific cycle.

{
  "customerId": "cus_abc123",
  "matcher": {
    "type": "CYCLE",
    "input": {
      "cycle": 4
    }
  },
  "action": {
    "type": "UPDATE_PAYMENT_METHOD",
    "input": {
      "paymentMethodId": "pm_abc123"
    }
  }
}

Modify product lines for a specific cycle.

{
  "customerId": "cus_abc123",
  "matcher": {
    "type": "CYCLE",
    "input": {
      "cycle": 2
    }
  },
  "action": {
    "type": "UPDATE_PRODUCTS",
    "input": {
      "lines": [
        {
          "lineId": "line_abc123",
          "quantity": 2
        },
        {
          "lineId": "line_def456",
          "variantId": "variant_xyz789"
        }
      ]
    }
  }
}

Each line requires lineId. Optional fields: variantId (swap variant), quantity (min 1), interval (override billing interval), nextBillingDate.

Apply a Shopify discount code to a specific cycle.

{
  "customerId": "cus_abc123",
  "matcher": {
    "type": "CYCLE",
    "input": {
      "cycle": 2
    }
  },
  "action": {
    "type": "APPLY_DISCOUNT",
    "input": {
      "discountSource": "code",
      "discountCode": "SAVE20"
    }
  }
}

APPLY_DISCOUNT only supports the CYCLE matcher. Discount must exist in Shopify and be valid for subscriptions.

Apply a manual discount to line items for a specific cycle.

{
  "customerId": "cus_abc123",
  "matcher": {
    "type": "CYCLE",
    "input": {
      "cycle": 2
    }
  },
  "action": {
    "type": "APPLY_DISCOUNT",
    "input": {
      "discountSource": "manual",
      "discountCode": "Loyalty Reward",
      "discountType": "percentage",
      "value": 15,
      "targetType": "line_item",
      "targeting": {
        "type": "all"
      }
    }
  }
}

Manual discounts support targetType of "line_item" or "shipping", with targeting options for "all" or specific "products".

Apply a manual discount to shipping for a specific cycle.

{
  "customerId": "cus_abc123",
  "matcher": {
    "type": "CYCLE",
    "input": {
      "cycle": 2
    }
  },
  "action": {
    "type": "APPLY_DISCOUNT",
    "input": {
      "discountSource": "manual",
      "discountCode": "Free Shipping",
      "discountType": "percentage",
      "value": 100,
      "targetType": "shipping",
      "targeting": {
        "type": "all"
      }
    }
  }
}

Only supports free shipping discounts. For shipping discounts, discountType must be "percentage", value must be 100, targetType must be "shipping", and targeting must be { "type": "all" }.

Authorizations

X-Juo-Admin-Api-Key

string

header

required

Headers

X-Tenant-ID

string

Unique identifier of the tenant in the system (usually a store identifier)

Body

application/json

customerId

string

required

The customer identifier

Minimum string length: 1

matcher

object

required

Match by cycle number

Option 1
Option 2
Option 3

Show child attributes

action

object

required

Skip an order in the schedule

Show child attributes

Response

201 - application/json

Default Response

string<uuid>

required

The adjustment identifier

resource

enum<string>

required

Available options:

schedule_adjustment

customer

string

required

The customer identifier

Minimum string length: 1

matcher

object

required

Show child attributes

action

object

required

Show child attributes

actor

object

required

Show child attributes

createdAt

string<date-time>

required

Creation date of the adjustment

updatedAt

string<date-time>

required

Last update date of the adjustment

List schedule adjustments Delete a schedule adjustment

⌘I

Documentation Index

​Examples

Authorizations

Headers

Body

Response

Examples