Verify a gift [Beta]

Use this endpoint to verify whether a gift code provided by the user is valid. The gift code has to be verified before a gift is redeemed.

🚧

Beta

Please note that gift subscriptions feature has been introduced as a Beta feature, meaning it's ready for real-world use while we gather user feedback to enhance its functionality and address any minor issues.

Response description

ResponseTypeDescription
redeemablebooleanGift status - whether it can be redeemed or not.
redeemModestringProvides information on a gift redeem mode - whether a new subscription will be created or an existing one will be extended as a result of redeeming a gift. If redeemable = true, the possible values are NEW, EXTEND. If redeemable = false, null will be returned.
redeemRefusalReasonstringProvides information why a gift could not be redeemed. Possible refusal reasons: REDEEMED, RECURRING PROCESS ALREADY STARTED, INACTIVE OFFER, MORE THAN ONE MATCHING SUBSCRIPTION, EXTERNALLY MANAGED SUBSCRIPTION, OFFER GEO RESTRICTED, PUBLISHER GEO RESTRICTED.
extendedSubscriptionIdintegerThe identifier of a subscription that has been extended as a result of redeeming a gift.
offerIdstringThe identifier of a Cleeng offer. Example: S123123123_US.
Language
Authorization
Header
Click Try It! to start a request and see the response here!