Redeem Subscription

This endpoint can be used to redeem a gift subscription.

Log in to see full request history
Query Params
int32
required

The unique identifier of the site associated with your account.

Body Params
string
required

The gift code used to redeem the subscription. The gift code must be existing and valid (not redeemed) - Always required.

int32
required

The unique identifier of the gift recipient. The gift recipient must be an existing customer on the associated site - Always required.

int32

The unique identifier of an existing subscription on which you would like to redeem this gift as a future phase on. If not provided, the gift will be created as a new subscription - Optional.

int32

The unique identifier of user's shipping address - Optional, unless taxes are enabled on the account, the gift product requires an address or validated against specific countries.

Headers
string
required
Defaults to Bearer eyJ***
Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json