Redemptions

Retrieve redemption history, if any, for a given program membership.

get

Invoke this endpoint to return an array of rewards that were redeemed while associated with a specified program membership.

Authorizations

Path parameters

program_membership_idanyrequired

the program membership id

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v2/program-memberships/{program_membership_id}/redemptions' \
  --header 'X-API-Key: YOUR_API_KEY'

200

200

{
  "redemptions": [
    {
      "date": 1,
      "description": "text",
      "code": "text"
    }
  ]
}

OK

Generate a redemption code for a given reward by providing the program_membership_id and reward_id.

post

Utilize this endpoint to generate a redemption code for a given reward.

Authorizations

Path parameters

program_membership_idanyrequired

the program membership id

Body

reward_idstringrequired

the reward uuid

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v2/program-memberships/{program_membership_id}/redemptions' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'reward_id=text'

200

404

200

{
  "redemption": {
    "uuid": "text",
    "code": "text",
    "promo_code": "text",
    "state": "text",
    "expires_at": 1
  }
}

OK