UserSubscription
Customer-facing membership subscription APIs for sales channel storefronts. Provides the active membership plan for a sales channel and subscription details for authenticated customers including savings breakdown and order history.
Apply membership cohort pricing to a cart before rendering. Called synchronously by the storefront before fetching the cart breakup. Requires authentication via sales channel customer JWT.
Operations
GET
# Apply membership cohort pricing to cart
FDK Method Name: applyMembershipCartPricing
Synchronous cart pricing endpoint called by the storefront BEFORE rendering the cart UI. Checks if the authenticated customer has an active subscription, matches cohort pricing rules against customer attributes, and pushes a price adjustment to megatron. Returns whether pricing was adjusted and which benefits were applied. Idempotent — safe to call multiple times for the same cart.
Parameters
cart_id
string
Required
The cart ID to apply membership pricing to
Response
200
Cart pricing result (adjusted or not)
CartPricingResult
data
object (CartPricingData)
CartPricingData
adjusted
boolean
Whether cohort pricing was applied
cart_id
string
The cart ID
plan_id
string
Plan ID (only when adjusted=true)
cohort_price
number
Applied cohort price (only when adjusted=true)
original_price
number
Original selling price (only when adjusted=true)
benefits_applied
array of string
Benefit types applied (only when adjusted=true)
Enum
message
string
Human-readable message
reason
string
Reason for non-adjustment (only when adjusted=false)
Enum
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
error
Undefined Type
Nullable
Null on success
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
Apply membership cohort pricing to cart
applyMembershipCartPricing
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
subscription
object (CustomerSubscription)
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
orders_remaining
integer
Nullable
Remaining benefit-eligible orders
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)
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
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 the active membership plan 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 plan
FDK Method Name: getActiveMembershipPlan
Returns the currently ACTIVE membership plan for this sales channel, including plan details (identifier, duration, benefits sorted by priority, pricing, savings calculator) and the customer's membership status. Accessible without authentication — unauthenticated users receive customer_status=UNSUBSCRIBED. Authenticated users receive their actual status (SUBSCRIBED, EXPIRED, BLOCKED, or UNSUBSCRIBED). Customers in restricted cohorts receive BLOCKED status.
Parameters
No Parameters
Response
200
Active plan with customer status
ActivePlan
plan
object (MembershipPlanSummary)
Nullable
MembershipPlanSummary
_id
string
Plan ID
identifier
string
Plan identifier
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
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.
customer_status
string
Customer's membership status
Enum
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