A membership represents a subscription plan customers can purchase to receive ongoing loyalty benefits. Like VIP tiers, memberships support a set ofDocumentation Index
Fetch the complete documentation index at: https://docs.yuko.so/llms.txt
Use this file to discover all available pages before exploring further.
benefits (discounts, store credit, bonus points, free shipping, or free products) but are tied to a recurring billing subscription rather than a points threshold.
uuid
string<uuid>
Unique UUID identifier for the membership.
Example:
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
org_uuid
string<uuid>
The UUID of the organisation this membership belongs to.
Example:
"05ca3845-6571-49a5-8d95-2f5d3c13ce5a"
name
string
The display name of the membership plan.
Example:
"Gold Member"
description
string | null
A description of the membership plan shown to customers.
Example:
"Get exclusive discounts and free shipping every month."
identifier
string | null
A unique slug-style identifier for the membership, unique per organisation.
Example:
"GOLDMEMBER"
segment_id
string | null
The segment ID associated with this membership for targeting purposes.
Example:
"seg_001"
merchant_code
string | null
A merchant-defined code for this membership plan.
Example:
"GOLD-2026"
platform_selling_plan_id
string | null
The selling plan ID in the external ecommerce platform (e.g. Shopify).
Example:
"123456789"
platform_selling_plan_group_id
string | null
The selling plan group ID in the external ecommerce platform.
Example:
"987654321"
selected_product_uuid
string<uuid> | null
The UUID of the product associated with this membership plan.
Example:
"b2c3d4e5-f6a7-8901-bcde-f01234567890"
price
number | null
The recurring price of the membership.
Example:
9.99
billing_interval
string | null
The billing frequency unit.
Available options:
DAY,
WEEK,
MONTH,
YEAR
Example:
"MONTH"
billing_interval_count
integer
The number of billing interval units between charges. For example, 3 with MONTH means billing every 3 months.
Example:
1
discount_type
string | null
The type of discount applied to subscribed orders.
Example:
"percentage"
billing_policy
object | null
The billing policy configuration for this membership.
Example:
null
delivery_policy
object | null
The delivery policy configuration for this membership.
Example:
null
pricing_policies
object | null
Pricing policy overrides for subscribed orders.
Example:
null
options
object | null
Additional plan options.
Example:
null
status
enum<string>
The current status of the membership plan.
Available options:
active,
inactive,
archived
Example:
"active"
benefits
object[]
A list of benefits associated with this membership. Benefits are automatically issued to customers when they subscribe or on a recurring schedule.
Hide child attributes
benefits.uuid
string<uuid>
Unique identifier for the benefit.
Example:
"c3d4e5f6-a7b8-9012-cdef-012345678901"
benefits.benefitable_uuid
string<uuid>
The UUID of the membership this benefit belongs to.
Example:
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
benefits.benefitable_type
string
The type of entity this benefit belongs to. Always membership for membership benefits.
Example:
"membership"
benefits.name
string
The display name of the benefit.
Example:
"10% Monthly Discount"
benefits.benefit_type
enum<string>
The type of benefit issued to the customer.
Available options:
fixed,
percentage,
store_credit,
bonus_points,
free_shipping,
free_product
Example:
"percentage"
benefits.benefit_value
object
The value configuration for this benefit.
Show child attributes
benefits.benefit_value.method
enum<string>
How the benefit is delivered.
Available options:
one_time,
automatic
Example:
"automatic"
benefits.benefit_value.value
number
The discount amount or percentage, depending on benefit_type.
Example:
10
benefits.benefit_value.recursive_interval
integer | null
How often the benefit repeats. Only present when method is automatic.
Example:
1
benefits.benefit_value.recursive_range
string | null
The time unit for the recurring interval. Only present when method is automatic.
Available options:
weeks,
months,
years
Example:
"months"
benefits.benefit_value.recursive_max_time
integer | null
The maximum number of times the benefit is issued. 0 means unlimited. Only present when method is automatic.
Example:
0
benefits.platform_discount_id
string | null
The discount identifier in the external ecommerce platform for this benefit.
Example:
"1121797341367"
benefits.ordering
integer
The sort order of the benefit within the membership.
Example:
0
benefits.metadata
object | null
Additional metadata for the benefit.
Example:
null
benefits.created_at
string<date-time>
The date and time when the benefit was created.
Example:
"2026-02-12T10:00:00.000Z"
benefits.updated_at
string<date-time>
The date and time when the benefit was last updated.
Example:
"2026-02-12T10:00:00.000Z"
metadata
object | null
Additional metadata for the membership.
Example:
null
created_at
string<date-time>
The date and time when the membership was created.
Example:
"2026-02-12T10:00:00.000Z"
updated_at
string<date-time>
The date and time when the membership was last updated.
Example:
"2026-02-12T10:00:00.000Z"
deleted_at
string<date-time> | null
The date and time when the membership was deleted. null if not deleted.
Example:
null