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, cumulative savings breakdown, and per-order savings history. Requires authentication via sales channel customer JWT.
Parameters
No Parameters
Response
200
401
Customer subscription details with order history
CustomerSubscriptionDetail
status
object (CustomerMembershipStatus)
Enum
subscription
object (CustomerSubscription)
Nullable
CustomerSubscription
_id
string
Subscription ID
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
total_savings
number
Sum of membership discount, delivery fee, platform fee, and cashback savings.
savings
object (SavingsBreakdown)
SavingsBreakdown
membership_discount
number
Total membership discount savings
delivery_fee
number
Total delivery fee savings (reserved)
platform_fee
number
Total platform fee savings (reserved)
cashback_earned
number
Total 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.
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. This is a public endpoint accessible without authentication, allowing storefront themes to display membership plan details to all visitors.
Operations
GET
# Get active membership plans
FDK Method Name: getActiveMembershipPlans
Returns currently ACTIVE membership plans for this sales channel, including plan details (identifier, 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.
Parameters
No Parameters
Response
200
Active membership plans
MembershipPlanCollection
items
array of object (MembershipPlanSummary)
Active membership plans. Current business setup returns zero or one item.
Array of MembershipPlanSummary
_id
string
Plan ID
identifier
string
Plan identifier
product_id
string
Membership product ID linked to this plan
status
object (CustomerMembershipStatus)
Enum
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 and SUPERCASH benefit types.
value_type
string
Benefit value type for MEMBERSHIP_DISCOUNT and SUPERCASH benefit types.
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