Skip to main content
POST
Redeem a gift code as the logged-in customer

Body Parameters

This endpoint requires an active portal session. The customer must be logged into the portal before redeeming a gift code.

Example Request

Response

Returns the subscription object created from the redeemed gift.
Each gift code can only be redeemed once. Attempting to redeem an already-used or expired code returns a 422 validation error.

Authorizations

portal_session
string
cookie
required

Customer-portal session cookie issued by GET /portal/auth/verify.

Body

application/json
code
string
required

Response

Gift redeemed.

message
string