Redeem subscription

post

https://www.pelcro.com/api/v1/core/subscriptions/redeem

Redeem a gift subscription.

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

Body Params

gift_code

string

required

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

user_id

int32

required

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

subscription_id

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.

address_id

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

Authorization

string

required

Defaults to Bearer eyJ***

Responses

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success.

400Invalid request.

401Unauthenticated.