Metafields are set by Supercycle and should not be edited manually
Product Metafields
Supercycle adds metafields to products to enable circular commerce methods. These metafields configure which rental methods are available and how they work.Product configuration metafields
boolean
Indicates whether a product is enabled for Supercycle functionality. Set to
"true" when a product is imported to Supercycle, "false" when removed.integer
The total number of uncommitted inventory available across all variants.
Method Configuration Metafields
These metafields contain the detailed configuration for each circular commerce method.list.single_line_text_field
Lists all rental methods enabled for this product. Array of method names:
["Calendar", "Membership", "Subscription", "Resale"]. Used by app blocks to determine which rental methods to display.json
Configuration for calendar rental method.
json
Configuration for membership rental method.
json
Configuration for subscription rental method.
json
Configuration for resale method.
Variant Metafields
Supercycle adds metafields to product variants to track inventory availability and membership pricing.Inventory Metafields
boolean
Indicates if variant has uncommitted inventory available. Used for inventory filtering in collections.
number_integer
The number of physical inventory items for this variant that are currently available — specifically items that are both visible (not hidden/retired) and not committed to an active rental.
boolean
Indicates if variant has future availability inventory. Used for calendar rental availability filtering.
Membership Metafields
number_integer
Credit cost for this variant in membership rental. Used by membership rental method to determine pricing.
number_integer
Credit allowance for this variant in membership plans. Used by membership plans to set credit limits.
Customer Metafields
Supercycle adds metafields to customers to track membership status and payment information.Membership Metafields
json
Customer’s membership information and quotas.
Payment Metafields
boolean
Indicates if customer has a vaulted payment method. Used for payment method validation in cart.
Usage Examples
Checking if a product has a method:
Checking customer membership:
Use metafields for merchandising
You can use metafields to merchandising your products. For example, you can use thesupercycle.uncommitted_inventory metafield in an automatic collection to only show products that are available now.