Get self-serve refund eligibility

Returns whether the authenticated user can self-serve refund their most recent purchase, including the refund window and cooldown timestamps.

get/premium/refund-eligibility

Response

Success

eligibleboolean required

Whether the authenticated user can self-serve refund their latest purchase right now

reason'no_refundable_purchase' | 'outside_refund_window' | 'cooldown_active' | 'feature_unavailable' required

invoice_idstring nullable required

Latest paid invoice considered for refund eligibility

invoice_amount_paid_centsinteger nullable required

Amount paid on the latest invoice in the currency minor unit

currencystring nullable required

Currency of the latest paid invoice

paid_atstring nullable required

ISO timestamp the latest invoice was paid

refund_window_expires_atstring nullable required

ISO timestamp after which the 3-day refund window closes

cooldown_expires_atstring nullable required

ISO timestamp the 30-day cooldown ends, if currently active

cancels_subscriptionboolean required

Whether issuing the refund will also cancel the active subscription