UserSubscription
Customer-facing membership subscription APIs for sales channel storefronts. Provides active membership plans for a sales channel and subscription details for authenticated customers including savings breakdown and order history.
View subscription details, savings breakdown, and per-order savings history for authenticated customers. Requires a sales channel customer JWT.
Operations
GET
# Get customer subscription details
FDK Method Name: getCustomerSubscription
Returns the current or most recent subscription for the authenticated customer, including status, validity dates, remaining order count, latest subscription savings, same-plan lifetime savings, and paginated same-plan per-order savings history. Requires authentication via sales channel customer JWT.
Parameters
page
integer
| value >= 1
Page number for same-plan order history.
Default Value : 1
limit
integer
| value >= 1
| value <= 50
Order history page size. Values above 50 are capped to 50.
Default Value : 20
Response
200
401
Customer subscription details with order history
CustomerSubscriptionDetail
status
object (CustomerMembershipStatus)
Enum
subscription
object (CustomerSubscription)
Nullable
CustomerSubscription
_id
string
Subscription ID
user_id
string
Customer user ID associated with this subscription
plan_id
string
Plan ID
plan_slug
string
Plan identifier
status
string
Subscription status
Enum
purchase_date
string
| date-time
When the subscription was purchased
valid_until
string
| date-time
Subscription expiry date
order_count
integer
Number of benefit-eligible orders consumed in the current subscription.
orders_remaining
integer
Nullable
Remaining benefit-eligible orders
latest_subscription_total_savings
number
Sum of savings from the subscription row returned in this response.
latest_subscription_savings
object (SavingsBreakdown)
Savings breakdown from the subscription row returned in this response.
SavingsBreakdown
membership_discount
number
Membership discount savings
delivery_fee
number
Delivery fee savings
platform_fee
number
Platform fee savings
cashback_earned
number
Cashback earned
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
lifetime_total_savings
number
Same-plan lifetime sum of membership discount, delivery fee, platform fee, and cashback savings.
lifetime_savings
object (SavingsBreakdown)
Same-plan lifetime savings breakdown across all subscription rows for this customer and plan.
SavingsBreakdown
membership_discount
number
Membership discount savings
delivery_fee
number
Delivery fee savings
platform_fee
number
Platform fee savings
cashback_earned
number
Cashback earned
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
order_history
object (OrderSavingsHistory)
oneOf Schema from below
OrderSavingsHistory
docs
array of object (OrderSavingsRecord)
Array of OrderSavingsRecord
_id
string
Record ID
fynd_order_id
string
Fynd order ID
savings
object (OrderSavings)
OrderSavings
membership_discount
number
Membership discount applied
delivery_fee
number
Delivery fee waived on this order
platform_fee
number
Platform fee waived on this order
cashback_earned
number
Cashback earned on this order
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
subscription_cycle_id
string
Subscription cycle ID that the order belonged to, when available.
created_at
string
| date-time
Record creation timestamp
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
total_docs
integer
Total number of documents
limit
integer
Items per page
page
integer
Current page
total_pages
integer
Total pages
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get customer subscription details
getCustomerSubscription
View active membership plans for a sales channel. Customer context is optional; when supplied, storefront clients receive customer-specific membership status with plan details.
Operations
GET
# Get active membership plans
FDK Method Name: getActiveMembershipPlans
Returns currently ACTIVE membership plans for this sales channel, including plan details (identifier, display name, duration, benefits sorted by priority, pricing, savings calculator). The business currently keeps one active plan per sales channel, but the response is an array so storefront clients can safely read the first item today and remain compatible if multiple active plans are supported later. If sales channel customer context is supplied, the status is resolved for that customer; otherwise the plan is returned with default UNSUBSCRIBED status. Each plan item includes can_buy so clients can decide whether the customer can purchase that plan.
Parameters
No Parameters
Response
200
Active membership plans
MembershipPlanCollection
items
array of object (MembershipPlanSummary)
Active sellable membership plans. Existing subscribers may also receive their disabled subscribed plan with active false.
Array of MembershipPlanSummary
_id
string
Plan ID
identifier
string
Plan identifier
display_name
string
Customer-facing plan display name.
product_id
string
Membership product ID linked to this plan
product_slug
string
Nullable
Storefront product slug linked to this plan.
description
string
Customer-facing plan description.
active
boolean
Whether the membership plan is currently sellable. Disabled plans can be shown to existing subscribers with active false.
status
object (CustomerMembershipStatus)
Enum
can_buy
boolean
Whether the customer can buy this plan. False when already subscribed or blocked; true when unsubscribed or expired.
duration_months
integer
Plan duration in months
order_limit
integer
Nullable
Max benefit-eligible orders
benefits
array of object (BenefitSummary)
Benefits sorted by priority
Array of BenefitSummary
name
string
Benefit name
description
string
Benefit description
type
string
Benefit type
Enum
value
number
Benefit value for MEMBERSHIP_DISCOUNT benefit type. SUPERCASH does not use this field.
value_type
string
Benefit value type for MEMBERSHIP_DISCOUNT benefit type. SUPERCASH does not use this field.
Enum
icon
string
Benefit icon URL
priority
integer
Display priority
is_monetary
boolean
Whether this benefit has monetary value
cashback_config
object (CashbackConfig)
CashbackConfig
amount
number
Cashback amount per order
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
price
object (PlanPrice)
PlanPrice
mrp
number
Maximum retail price
selling_price
number
Effective selling price
savings_calculator
object (SavingsCalculator)
SavingsCalculator
per_order_saving
number
Saving per order
display_text
string
Display text
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response