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. It returns the available redemption options for the gift.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requestsā¦ | |||
Loadingā¦
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, EXTERNALLY_MANAGED_SUBSCRIPTION, OFFER_GEO_RESTRICTED, PUBLISHER_GEO_RESTRICTED, SEASONAL_SUBSCRIPTION, ACTIVE_PASS,NO_REDEEM_OPTION_AVAILABLE. |
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. |
gift | object | Details of the gift |
gift.value | number | Monetary value of the gift |
gift.currency | string | Currency of value |
gift.duration.days | integer | Duration of the gift, in days |
redeemOptions[] | array of objects | Every redemption option currently available for this gift. |
| Redeem option object: | ||
| string | NEW, EXTEND, or SWITCH |
| integer | Subscription this option applies to (for EXTENDSWITCH); null for NEW |
| string | Offer the customer is currently subscribed to, if any |
| string | Offer the gift grants |
| array of string | Additional effects of choosing this option: RESUMES_SUBSCRIPTION, CANCELS_SCHEDULED_SWITCH |
| timestamp | Resulting subscription end date if this option is redeemed |
| integer | Days added to the subscription |
| object | Time/value carried over from the current cycle, if applicable |
| ||
| object | Resulting renewal offer/billing cycle after redemption, if applicable. |
| string | ID of the offer the subscription renews on after the gifted period |
| object | How often the customer is charged after the gifted period ends, taken from the gifted offer. Null when the gifted offer has no billing cycle. |
| integer | Number of periodUnits in one billing cycle. For example, 3 with month means the customer is charged every 3 months. Example: 1. |
| string | Unit of the billing cycle: day, week, month, year or season. Example:month. |
unavailableOptions[] | array of objects | Redemption options that exist but are currently unavailable, with the reason why. |
| Unavailable option object: | ||
| string | NEW, EXTEND, or SWITCH |
| integer | Subscription this option would have applied to, if any |
| string | Offer the customer is currently subscribed to, if any |
| string | Why the option is unavailable: PAUSED_SUBSCRIPTION, CURRENT_CYCLE_FROM_GIFT, SWITCH_PAYMENT_IN_PROGRESS, LOWER_TIER_NOT_ALLOWED, FREE_OFFER_SUBSCRIPTION, ACTIVE_PASS, SEASONAL_SUBSCRIPTION or EXISTING_SUBSCRIPTION |