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

​
supercycle.supercycle_enabled
boolean
Indicates whether a product is enabled for Supercycle functionality. Set to "true" when a product is imported to Supercycle, "false" when removed.

​
Method Configuration Metafields

These metafields contain the detailed configuration for each circular commerce method.
​
supercycle.methods
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.
​
supercycle.calendar_configuration
json
Configuration for calendar rental method.
​
supercycle.membership_configuration
json
Configuration for membership rental method.
​
supercycle.subscription_configuration
json
Configuration for subscription rental method.
​
supercycle.resale_configuration
json
Configuration for resale method.

​
Variant Metafields

Supercycle adds metafields to product variants to track inventory availability and membership pricing.

​
Inventory Metafields

​
supercycle.uncommitted_inventory
boolean
Indicates if variant has uncommitted inventory available. Used for inventory filtering in collections.
​
supercycle.future_availability_inventory
boolean
Indicates if variant has future availability inventory. Used for calendar rental availability filtering.

​
Membership Metafields

​
supercycle.credit_cost
number_integer
Credit cost for this variant in membership rental. Used by membership rental method to determine pricing.
​
supercycle.credit_allowance
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

​
supercycle.membership
json
Customer’s membership information and quotas.

​
Payment Metafields

​
supercycle.vaulted_payment_method
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:

{% comment %} Check if product has calendar rental method {% endcomment %}
{% if product.metafields.supercycle.methods contains "Calendar" %}
  <!-- Product has calendar rental available -->
{% endif %}

{% comment %} Check if product has membership rental method {% endcomment %}
{% if product.metafields.supercycle.methods contains "Membership" %}
  <!-- Product has membership rental available -->
{% endif %}

{% comment %} Check if product has subscription rental method {% endcomment %}
{% if product.metafields.supercycle.methods contains "Subscription" %}
  <!-- Product has subscription rental available -->
{% endif %}

{% comment %} Check if product has resale method {% endcomment %}
{% if product.metafields.supercycle.methods contains "Resale" %}
  <!-- Product has resale available -->
{% endif %}

​
Checking customer membership:

{% assign membership = customer.metafields.supercycle.membership.value %}
{% if membership.quotas.credits.allowance > 0 %}
  <!-- Customer has credit allowance -->
{% endif %}

​
Use metafields for merchandising

You can use metafields to merchandising your products. For example, you can use the supercycle.uncommitted_inventory metafield in an automatic collection to only show products that are available now.