Cycle line item property

The _cycle line item property is a JSON-encoded object holding everything Supercycle needs to create a cycle from a line item when the order is placed. A line item without a _cycle property isn’t processed by Supercycle.

The _cycle format can change between releases. Integrations and automations should build on Shopify Flow rather than parse this property.

How it works

Fetch the property

When a customer selects a method option, the Intent endpoint returns the _cycle property. The Methods app block does this for you. A custom storefront calls the endpoint directly.

Submit it with the cart line

The properties[_cycle] value goes into the add-to-cart request as a hidden input or a form data field.

Create the cycle

When the order is created, Supercycle reads the _cycle property and creates a cycle for that line item.

Examples

{
  "item": {
    "type": "existing",
    "filters": {
      "availability": { "from": "2025-01-01", "to": "2025-01-14" },
      "location": { "shopify_id": 123456 },
      "condition": { "ids": [1, 2] }
    }
  },
  "attachments": {
    "deposit": { "variant_id": 987654 },
    "membership_credit": { "cost": 5 },
    "subscription_contract_creator": { "selling_plan_id": 123 },
    "custom_fields": {
      "damage_waiver_taken": "true",
      "message": "Happy Birthday"
    }
  },
  "method_type": "subscription",
  "minimum_term": "3 months",
  "rental_start": "2025-01-01"
}

{
  "item": {
    "type": "existing",
    "filters": {
      "availability": { "from": "2025-01-10", "to": "2026-01-15" },
      "location": { "shopify_id": 789 }
    }
  },
  "attachments": {
    "custom_fields": {
      "delivery_notes": "Leave at the front desk"
    }
  },
  "method_type": "calendar",
  "rental_start": "2025-01-05",
  "rental_end": "2025-01-20"
}

{
  "item": {
    "type": "existing",
    "filters": {
      "availability": { "from": "2026-03-15", "to": "2026-04-15" }
    }
  },
  "attachments": {
    "membership_credit": { "cost": 20 },
    "custom_fields": { "backup_item": "234450" }
  },
  "method_type": "membership",
  "rental_start": "2026-03-15",
  "rental_end": "2026-04-15"
}

{
  "item": {
    "type": "existing",
    "filters": {
      "availability": { "from": "2026-04-01", "to": "2026-04-30" },
      "location": { "shopify_id": 555 },
      "condition": { "ids": [1] }
    }
  },
  "attachments": {
    "deposit": { "variant_id": 999 }
  },
  "method_type": "subscription",
  "rental_start": "2026-04-01",
  "rental_end": "2026-04-30"
}

{
  "item": {
    "type": "existing",
    "filters": {
      "location": { "shopify_id": 123456 },
      "condition": { "ids": [3] }
    }
  },
  "attachments": {
    "custom_fields": {
      "gift_message": "Enjoy"
    }
  },
  "method_type": "resale"
}

Schema

object

required

How Supercycle selects an inventory item to assign to the cycle.

Show properties

string

required

Always "existing", which selects from existing inventory items.

object

Filters that narrow down which inventory item is selected.

Show properties

object

Restricts selection to items available within a date range.

Show properties

date

Start of the required availability window.

date

End of the required availability window.

object

Restricts selection to items at a specific Shopify location.

Show properties

integer

Shopify ID of the location.

object

Restricts selection to items in specific conditions.

Show properties

integer[]

Supercycle condition IDs the item must match.

object

Optional objects applied to the cycle after it’s created. Only the relevant keys are present.

Show properties

object

Links a deposit line item to the cycle.

Show properties

integer

Shopify variant ID of the deposit.

object

Deducts credits from the customer’s membership balance.

Show properties

integer

Number of credits to deduct.

string

The condition the item must come back in for the credits to be returned.

object

Creates a Shopify subscription contract for the cycle. Used where selling plans aren’t available, for example on draft orders.

Show properties

integer

Shopify selling plan ID used to configure the contract.

object

Key-value pairs of custom field values to attach to the cycle. Keys must match your custom field definitions.

string

The method. One of "subscription", "membership", "calendar", or "resale".

date

The requested rental start date. Present for the subscription and calendar methods.

date

The requested rental end date. Present for the calendar and membership methods.

string

The minimum rental duration. Present for the subscription method.

Introduction

App blocks

Code snippets

Guides

Troubleshooting

Cycle line item property

How it works

Examples

Schema

​How it works

​Examples

​Schema

How it works

Examples

Schema