Get subscription details
Returns the subscription details for the authenticated user including plan, features, and billing information.
Get subscription details › Responses
Subscription details
owner_idOwner ID
statusSubscription status (active, cancelled, in_trial, etc.)
mrrMonthly recurring revenue in cents
has_scheduled_changesWhether subscription has pending changes
next_billing_atUnix timestamp of next billing date (null if not scheduled)
current_term_startUnix timestamp of current term start (null if not applicable)
current_term_endUnix timestamp of current term end (null if not applicable)
trial_startUnix timestamp of trial start (null if not in trial)
trial_endUnix timestamp of trial end (null if not in trial)
cancelled_atUnix timestamp when cancelled (null if not cancelled)
created_atUnix timestamp when subscription was created (null if not available)
chargebee_customer_idChargebee customer ID
chargebee_subscription_idChargebee subscription ID
pause_dateUnix timestamp of scheduled or active pause (null if no pause)
resume_dateUnix timestamp when subscription will resume from pause (null if no pause)
emailChargebee customer email
nameChargebee customer full name (first_name + last_name)
billing_countryChargebee customer billing address country (ISO 3166-1 alpha-2)
Submit cancellation feedback
Submits cancellation feedback from the cancel flow. Enriches with subscription data and relays to webhook.
Submit cancellation feedback › Request Body
event_typeCancellation flow event type
flow_typeType of cancel flow
languageUser's language code
reasonLegacy alias for canonical English reason label
reason_codeCanonical reason code for cancellation
reason_labelCanonical English reason label. Free translated UI copy should not be sent here.
follow_up_responseFollow-up response text
feedbackFree-text feedback
outcomeOutcome of the cancel flow
offer_shownRetention offer shown to user
offer_selectedRetention action selected by user
offer_acceptedWhether the user accepted the offer
pause_duration_monthsPause duration in months when offer_selected is PAUSE
billing_countryUser's billing country code
plan_idOptional client-provided plan ID used as analytics context when subscription enrichment cannot provide a non-empty server value; backend subscription value wins when available
subscription_statusOptional client-provided subscription status used as analytics context when subscription enrichment cannot provide a non-empty server value; backend subscription value wins when available
created_at_clientOptional client timestamp for late-arrival ordering. Server created_at remains authoritative.
Submit cancellation feedback › Responses
Feedback submitted
successCheck discount eligibility
Checks if the authenticated user is eligible for a cancel-flow discount coupon.
Check discount eligibility › Responses
Discount eligibility result
eligibleWhether user can receive a discount
last_discount_dateISO 8601 timestamp of last discount (empty string if never)
cooldown_monthsCooldown period in months (always 12)
eligible_afterISO 8601 date when eligible again (empty string if eligible now)
current_couponsActive coupon IDs on subscription
has_cancel_flow_couponWhether a cancel-flow coupon is active
Pause subscription
Schedules a subscription pause at end of current term.
Pause subscription › Request Body
pause_monthsNumber of months to pause (1, 2, or 3)
Pause subscription › Responses
Subscription pause scheduled
successpause_dateISO 8601 timestamp when pause begins
resume_dateISO 8601 timestamp when subscription resumes
messageChange subscription plan
Extend trial period
Extends the trial period by the specified number of days (7 or 14).
Extend trial period › Request Body
extension_daysDays to extend trial (7 or 14)
Extend trial period › Responses
Trial extended
successnew_trial_endISO 8601 timestamp of new trial end
extended_by_daysActual days extended
message