API Documentation
App Store
Rewards Actions
Claim Actions
App Store
Get Offer Code
Get an offer code with subscription and prices by the offer code id.
GET
/
app-store
/
offer-codes
/
{offer_code_id}
curl --request GET \
--url https://api-v1.winwinkit.com/app-store/offer-codes/{offer_code_id} \
--header 'x-api-key: <x-api-key>'
{
"data": {
"offerCode": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Three months at 50% off",
"customer_eligibilities": [
"NEW",
"EXISTING",
"EXPIRED"
],
"offer_eligibility": "STACK_WITH_INTRO_OFFERS",
"duration": "THREE_MONTHS",
"offer_mode": "PAY_AS_YOU_GO",
"number_of_periods": 1,
"prices": [
{
"territory": "USA",
"price": "99.99",
"currency": "USD"
}
]
},
"subscription": {
"id": "1234567890",
"product_id": "com.winwinkit.app.yearly",
"name": "Yearly",
"subscription_period": "ONE_YEAR",
"prices": [
{
"territory": "USA",
"price": "99.99",
"currency": "USD"
}
]
}
}
}
Headers
The API key to authenticate with.
Path Parameters
The offer code id to retrieve.
Response
200
application/json
Offer Code object.
The response is of type object
.
curl --request GET \
--url https://api-v1.winwinkit.com/app-store/offer-codes/{offer_code_id} \
--header 'x-api-key: <x-api-key>'
{
"data": {
"offerCode": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Three months at 50% off",
"customer_eligibilities": [
"NEW",
"EXISTING",
"EXPIRED"
],
"offer_eligibility": "STACK_WITH_INTRO_OFFERS",
"duration": "THREE_MONTHS",
"offer_mode": "PAY_AS_YOU_GO",
"number_of_periods": 1,
"prices": [
{
"territory": "USA",
"price": "99.99",
"currency": "USD"
}
]
},
"subscription": {
"id": "1234567890",
"product_id": "com.winwinkit.app.yearly",
"name": "Yearly",
"subscription_period": "ONE_YEAR",
"prices": [
{
"territory": "USA",
"price": "99.99",
"currency": "USD"
}
]
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.