Redeem subscription

post

https://www.pelcro.com/api/v1/sdk/gift/redeem

This endpoint can be used to redeem a gift subscription.

This is a protected endpoint which requires proper authorization header to authenticate the customerand returns a Customer resource.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

Body Params

gift_code

string

required

address_id

int32

The identifier of the shipping address to associate with the subscription. Required if related product requires an address, if product is available only in certain countries, or if tax feature is enabled under your account.

language

string

enum

Defaults to en

The customer’s preferred language as a two-letter code, defined by ISO 639-1 standard. If not specified, it will be set from Accept-Language header, or from the default language defined in your site settings as a fallback.

Allowed:

subscription_id

int32

An optional 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.

Headers

Authorization

string

required

Defaults to Bearer eyJ***

string

Defaults to application/json

Responses

Language

Credentials

Query

Loading…

Response

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

application/json

200200

400400