get https://api.sandbox.cleeng.com/3.1/gifts//verification
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.
Response description
Response | Type | Description |
---|---|---|
redeemable | boolean | Gift status - whether it can be redeemed or not. |
redeemMode | string | Provides 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. |
redeemRefusalReason | string | Provides 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 . |
extendedSubscriptionId | integer | The identifier of a subscription that has been extended as a result of redeeming a gift. |
offerId | string | The identifier of a Cleeng offer. Example: S123123123_US. |