Sign in
Billing

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

Changes

Changed in 4 of the 21 revisions of this API.53229

  • dd0ad4ea1c8855See the full diff
    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ○

      response property cooldown_expires_at list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property currency list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property invoice_id list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property paid_at list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      response property refund_window_expires_at list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

  • a52a2cf49d9b32See the full diff
    • ●

      added the new IP_BAN_DECLINED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IP_BAN_DECLINED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IP_BAN_DECLINED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new IP_BAN_DECLINED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

      response-property-enum-value-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

  • 4dbb738a3e224See the full diff
    • ○

      removed the NSFW_EMOJI_STICKER_BLOCKED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the NSFW_EMOJI_STICKER_BLOCKED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the NSFW_EMOJI_STICKER_BLOCKED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the NSFW_EMOJI_STICKER_BLOCKED enum value from the response property for the response status

      response-property-enum-value-removed

  • fa36b1b48ca520See the full diff
    • ○

      removed the INVALID_PACK_TYPE enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the INVALID_PACK_TYPE enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the INVALID_PACK_TYPE enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the INVALID_PACK_TYPE enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACKS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACKS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACKS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACKS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACK_EXPRESSIONS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACK_EXPRESSIONS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACK_EXPRESSIONS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the MAX_PACK_EXPRESSIONS enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PACK_ACCESS_DENIED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PACK_ACCESS_DENIED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PACK_ACCESS_DENIED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PACK_ACCESS_DENIED enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the UNKNOWN_PACK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the UNKNOWN_PACK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the UNKNOWN_PACK enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the UNKNOWN_PACK enum value from the response property for the response status

      response-property-enum-value-removed

    This revision also has 17 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 21 revisions, 2 have no diff computed.