Billing

Get self-serve refund eligibility

Changed on

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

get/premium/refund-eligibility

Request

  • Base URL: https://web.fluxer.app/api/v1
  • URL: https://web.fluxer.app/api/v1/premium/refund-eligibility
  • Auth: API key in header Authorization

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

  • dd0ad4ea1c88Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

  • a52a2cf49d9bRevision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    This list may be incomplete.