Shopify Metafields Set by Subscribfy
Complete reference of all metafields that Subscribfy creates in your Shopify store
Shopify Metafields Set by Subscribfy
Complete reference of all metafields that Subscribfy creates and manages in your Shopify store.
Updated: 29.07.2025
Overview
Subscribfy stores configuration and customer data in Shopify metafields using the exison namespace. These metafields power features like VIP Membership, Store Credits, Loyalty Program, and Wallet Pass.
Metafield Types:
-
Shop Metafields - Store-wide settings and configuration
-
Customer Metafields - Individual customer data (subscriptions, credits, loyalty)
-
DiscountAutomaticNode Metafields - Discount function configuration
Shop Metafields
shop.metafields.exison.general
Internal system flags.
Field
Description
is_laravel
0/1 internal flag indicating Laravel backend
shop.metafields.exison.exison_plan_settings
VIP/Elite Membership plan configuration. This is the main metafield for membership settings.
Plan Settings
Field
Description
status
Plan disabled (0) or enabled (1)
type
1 = VIP, 2 = Elite
product_name
VIP product name (also serves as the VIP plan name)
product_price
VIP product price (membership price)
product_gid
Shopify product ID
product_variant_id
Shopify variant product ID
plan_id
Shopify subscription plan ID
plan_name
Subscription plan name (e.g., "billed every 1 month")
tier_name
VIP tier name (e.g., "VIP" - set from admin, also used as discount label)
i_name
Subscription plan interval name (week/month)
i_count
Subscription plan interval count (1-28)
scripts_on
Empty or 1 (Shopify Plus script/Functions enabled for VIP discount)
scripts_st_on
Empty/0 or 1 (Shopify Plus script handles store credit redemption)
function_on
Empty or 1 (Shopify Function Discount enabled) - in progress
checkout_ui
NOT used (03-2024) - replaced with shop.metafields.exison.otp
otp_enabled
NOT used (03-2024) - replaced with shop.metafields.exison.otp
allowed_countries
Comma-separated ISO 3166-1 alpha-2 country codes (e.g. CA, US, GB)
Perks
Field
Description
dp
Discounted products disabled (0) or enabled (1)
dv
Discount value
dt
Discount type: percentage or fixed
dat
Discount applies to: all, collection, or product
dproduct
Product IDs selected for VIP discount
dcollection
Collection IDs selected for VIP discount
ds
0/1 - Enable discount steps
ds_info
Discount steps rules
dct
1 or 2 - Method for calculating VIP discount: 1 = From original price (Compare at price if set) 2 = From sale (final) item price
stack_with_subs
0/1 - VIP discount stacks with subscription discounts on recurring charges
store_credit
0/1 - Store Credit enabled
store_credit_type
Type: coupon, function, storecredit shopify (in progress), giftcard
Welcome Offer
Additional discount on lowest priced product. Valid on first membership order only.
Field
Description
wo
Welcome offer disabled (0) or enabled (1)
wo_v
Welcome offer discount value
wo_t
Welcome offer discount type: percentage or fixed
wo_at
Welcome offer applies to: all, collection, or product
wo_product
Product IDs for welcome offer
wo_collection
Collection IDs for welcome offer
Free Trial
Field
Description
ft
Free trial disabled (0) or enabled (1)
ft_price
Trial price: $0 or custom value
ft_type
1 = Trial until next billing date 2 = Custom trial duration
ft_duration
Trial duration in days (when ft_type = 2)
Free Shipping
Field
Description
fs
Free shipping disabled (0) or enabled (1)
fs_country
Countries eligible for free shipping
fs_message
Discount message for shipping
fs_method_name
Shipping method name to discount (optional)
fs_threshold_type
Cart condition: 0, items, or subtotal
fs_threshold_value
Number of items or subtotal value required
shop.metafields.exison.exison_plan_settings2
Same structure as exison_plan_settings. Used for second membership plan (Elite).
shop.metafields.exison.exison_widget_cart_page
Cart page widget configuration for non-members.
Field
Description
cart_default_PAYG
0/1 - Default to pay-as-you-go
cart_disclaimer
Subscription agreement text
enable_progress_bar
0/1 - Show progress bar
hide_sp
"on" - Hide subscription products widget
hide_st
"on" (default unset) - Hide store credit widget from cart page
m_body
Membership offer details text
m_checkout_btn_name
Checkout button text
m_subtitle
Membership subtitle (e.g., "up to 50% OFF")
m_title
Membership title (e.g., "VIP Membership")
progress_bar_item
Progress bar item text with placeholders
progress_bar_title
Progress bar title
r_body
Regular purchase details text
r_subtitle
Regular purchase subtitle
r_title
Regular purchase title
subtitle
Main widget subtitle
shop.metafields.exison.exison_widget_cart_page_member
Cart page widget configuration for existing members.
Field
Description
m_body
Membership offer details
m_checkout_btn_name
Checkout button text
subtitle
Widget subtitle (e.g., "You're a VIP Member")
shop.metafields.exison.exison_cart_page_selector
CSS selectors for cart page integration.
Field
Description
cart_checkout_btn_selector
Checkout button selector
cart_form_selector
Cart form selector
cart_item_price_selector
Item price selector
cart_item_row_selector
Cart item row selector
theme_name_select
Theme identifier
shop.metafields.exison.exison_side_cart_selector
CSS selectors for side cart (drawer) integration.
Field
Description
btn_add_to_cart_selector
Add to cart button selector
cart_checkout_btn_selector
Checkout button selector
cart_drawer_selector
Cart drawer container selector
cart_form_selector
Side cart form selector
cart_item_price_selector
Item price selector
cart_item_row_selector
Cart item row selector
cart_summary_selector
Cart summary selector
status
"on"/"off" - Side cart enabled
theme_name_select
Theme identifier
trigger_selector
Element that triggers cart drawer
shop.metafields.exison.exison_otp
One-Time Password / Customer Identification settings.
Field
Description
otp_enabled
0/1 - OTP feature enabled
shop.metafields.exison.softlogin
Soft login settings for checkout integration.
{ "enabled": 1, "settings": { "checkout_button_no_popup": true, "cart_widget_login_link": true, "debug_functions_checkout_sc_ca_function": false, "debug_functions_cart_checkout_validation": false }}
shop.metafields.exison.exison_protection
Fraud protection settings.
Field
Description
exison_protection
0/1 - Protection enabled
shop.metafields.exison.exison_agreement
Subscription agreement widget settings.
Field
Description
agreement_enabled
0/1 - Enable agreement widget for subscription purchases
shop.metafields.exison.order_gift
Order gifting extension settings (In Progress).
Field
Description
enabled
0/1 - Order gift extension enabled
Customer Metafields
customer.metafields.exison.customer_subscription1
Primary membership subscription data.
Field
Description
name
Subscription name (e.g., "VIP Membership")
status
ACTIVE, CANCELLED, PAUSED, etc.
member_since
Membership start date
next_billing
Next billing date
scid
Subscription contract ID
price
Subscription price
currency
Currency code (e.g., "USD")
offers
Applied offers array (see below)
Offers Array Structure
// Discount price offer{ "offer_id": "id of the applied offer", "type": "discount_price", "discount_value": float, "discount_type": "fixed_amount" | "percentage", "recurring_cycle_limit": ?int}// Change frequency offer{ "offer_id": "id of the applied offer", "type": "change_frequency", "interval": "year" | "week" | "month" | "day", "interval_count": int}
customer.metafields.exison.customer_subscription2
Secondary membership subscription data (same structure as customer_subscription1).
Field
Description
name
Subscription name (e.g., "EliteBox Membership")
status
ACTIVE, CANCELLED, etc.
member_since
Membership start date
next_billing
Next billing date (empty if cancelled)
scid
Subscription contract ID
customer.metafields.exison.customer_subscription1_gifts
Customer's membership gifts to other users.
[ { "customer": { "id": "gid://shopify/Customer/123123123123", "email": "example@gmail.com", "name": "Example Example" }, "subscription": { "name": "Membership Example", "status": "ACTIVE", "member_since": "January 20, 2025", "next_billing": "February 2, 2025", "scid": 59 } }, ...]
customer.metafields.exison.customer_subscription1_parent
Customer's membership parent (if membership was gifted to them).
{ "subscription_id": "gid://shopify/SubscriptionContract/123123123123", "customer": { "id": "gid://shopify/Customer/123123123123", "email": "example@gmail.com", "name": "Example Example" }}
customer.metafields.exison.exison_hash
Unique hash token for customer identification.
customer.metafields.exison.exison_st
Store credits balance (in store base currency).
customer.metafields.exison.exison_st_id
Redemption store credits history ID. Can be used to validate credits amount used. (Not live)
customer.metafields.exison.exison_member_details
Loyalty program customer data.
Field
Description
loyalty_points
Current loyalty points balance
birth_date
Customer's birth date (for birthday rewards)
Discount Metafields
DiscountAutomaticNode.metafields.exison.exison_collection_ids
Collection IDs for VIP discount functions. Type: JSON.
Used by: VIP Discount (Subscribfy), VIP Shipping (Subscribfy)
{ "customerVipTag": ["EXM: VIP: Active"], "customerEliteTag": ["EXM: Elite: Active"], "collectionIds": [ "gid://shopify/Collection/440014831901", "gid://shopify/Collection/473486623005", "gid://shopify/Collection/463355740445" ]}
DiscountAutomaticNode.metafields.exison.vip_perk_shipping
Not used - Documented for reference.
Field
Description
handle
Shopify shipping method ID (e.g., "b781aea10ca815492d47f42538a619f4-8388085074acab7e91de633521be86f0")
customerTag
Customer tags JSON (e.g., '["EXM: VIP: Active"]')
Loyalty Metafields
shop.metafields.exison.exison_loyalty_settings
Main loyalty program settings.
Field
Description
loyalty_enabled
1/0 - Loyalty program active
tiers_enabled
1/0 - Tiered membership levels enabled
ratio_points
Points per dollar spent conversion ratio
reward_type
Main reward type (currently limited to "points")
shop.metafields.exison.exison_loyalty_tiers[]
Loyalty tier definitions (array).
Field
Description
name
Tier name (e.g., Silver, Gold)
description
Short description of tier benefits
is_active
Whether tier is currently active
entry_rules
JSON conditions to enter tier (min spend/points)
reward_rules
JSON defining tier rewards
multiplier_points
Point multiplier for tier (e.g., 1.2x)
order
Sort order of tiers
tag
Customer tag assigned when entering tier
shop.metafields.exison.exison_loyalty_rules[]
Loyalty earning rules (array).
Field
Description
id
Unique rule identifier
name
Rule name
type
Rule type (earn points, referral, birthday)
rules
Specific conditions for rule
enabled
Whether rule is active
reward_text
Description shown to customers
shop.metafields.exison.exison_loyalty_coupons[]
Loyalty redemption coupons (array).
Field
Description
name
Coupon name
type
Reward type (percentage, fixed amount)
rules
Redemption conditions
required_points
Points required to claim
discount_code_prefix
Prefix for generated discount codes
enabled
Whether coupon is active
starts_at
Start date
ends_at
Expiration date
Wallet Pass Metafields
shop.metafields.exison.exison_wallet_pass_settings
Wallet pass program settings.
Field
Description
wallet_pass_enabled
1/0 - Wallet pass program active
shop.metafields.exison.exison_wallet_pass_sale_campaigns[]
Wallet pass sale campaign definitions (array).
Field
Description
id
Unique campaign identifier
status
Campaign active/inactive
pop_up_image
Image path for campaign pop-up
pop_up_title
Pop-up title text
pop_up_text
Pop-up body text
starts_at
Campaign start date
ends_at
Campaign end date
Subscribfy Tags
Order Tags
Tags automatically added to orders by Subscribfy. ##{{vip}} represents your store's tier name.
Membership Orders
Tag
Description
new-##{{vip}}
New membership signup
##{{vip}}-Recharge
Membership renewal order
##{{vip}}
Order from active member
##{{vip}}-trial
Trial membership order
charge-##{{number}}
Charge sequence number
Product Subscription Orders
Tag
Description
New-SubsProd
New product subscription
SubsProd-Recharge
Subscription renewal
charge-##{{number}}
Charge sequence number
Store Credits
Tag
Description
credits-redeemed
Store credits were used
credits-redeemed-restored
Redeemed credits were restored
Chargebacks
Tag
Description
Chargeback-Alert-Refund
Chargeback alert refund
Chargeback-Bank-Refund
Chargeback bank refund
Custom Tags
Tag
Description
deliverySchedule: ##{{...}}
Delivery schedule information
mystery_gift
Mystery gift order
Product Tags
Tags you can add to products to control VIP discount behavior.
Tag
Description
NO-VIP-DISCOUNT
Exclude product from VIP discounts
100%-VIP-DISCOUNT
Apply 100% VIP discount to product
Customer Tags
Tags automatically added to customers by Subscribfy.
Tag
Description
EXM: VIP: Active
Active VIP member
EXM: Elite: Active
Active Elite member
EXM: Churn_Offer
Customer accepted one or more churn offers (ever)
EXM: Churn_Offer: Active
Customer has currently active churn offer
API Access
You can query Subscribfy metafields via the Shopify Admin API:
curl --location '##{{store}}/admin/api/2023-11/metafields.json?namespace=exison' \--header 'Content-Type: application/json' \--header 'X-Shopify-Access-Token: ##{{app secret}}'
Need help? Contact support at support@subscribfy.com