Overview
Gifting lets one customer pay for a subscription that someone else uses, and lets a recipient claim a gift they were given. A gift is purchased by a donor and later redeemed by the recipient with a gift code.
How It Works
- Gift a new subscription by passing
gift_recipient_emailwhen creating a subscription — the authenticated customer becomes the donor. - Renew a gift you previously gave for another term.
- Redeem a gift you received using its gift code.
API Endpoints
| Method | Endpoint | Description |
|---|---|---|
POST | /api/v1/sdk/subscription/gift/renew | Gift subscription |
POST | /api/v1/sdk/gift/redeem | Redeem subscription |
Important Behaviors
- All gift endpoints are protected (Bearer JWT); the customer is taken from the token.
- A gift must be paid and not already redeemed before it can be redeemed;
address_idis required when the gift's product ships.
