curl -X GET \
'https://api.appcharge.com/v2/offer' \
-H 'Content-Type: application/json' \
-H 'x-publisher-token: <x-publisher-token>' \
-d '{
}'
{
"totalCount": 2,
"offers": [
{
"publisherId": "35nb7861ec9924a6b69a0fe59",
"publisherOfferId": "post-purchase-1",
"name": "Purchase Reward Offer",
"displayName": "Purchase Reward Offer",
"description": "Post purchase offer for VIP players.",
"type": "PopUp",
"subType": "PostPurchase",
"active": true,
"segments": [],
"offerUi": {
"offerUiId": "68b41c5aa1c5b1a284737e9b",
"active": true,
"offerUiType": "PopUp",
"name": "popup",
"description": "description",
"backgroundImage": "https://media.appcharge.com/media/35nb7861ec9924a6b69a0fe59/2755379465856__fa883338-5790-47c8-a6a0-23cb43db58844",
"externalId": "popup"
},
"productsSequence": [
{
"index": 1,
"products": [
{
"product": {
"publisherProductId": "TreasureChest",
"name": "Treasure Chest",
"type": "Quantity",
"prefix": "$",
"suffix": "M",
"priority": "Main",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/35nb7861ec9924a6b69a0fe59/2208472.png"
},
{
"type": "productPrefix",
"url": ""
}
],
"displayName": "Treasure Chest"
}
}
]
}
],
"priority": 1,
"showAfter": "purchase",
"triggers": [
{
"type": "event",
"eventName": "purchase",
"every": 1,
"rules": []
}
],
"createdAt": "2025-09-01T14:16:09.499Z",
"updatedAt": "2025-09-01T14:16:09.499Z",
"offerId": "68b5aaa9b73fceb9ffc26f9b"
},
{
"publisherId": "35nb7861ec9924a6b69a0fe59",
"offerId": "726cff96123a8717",
"publisherOfferId": "rolling-offer-1",
"name": "My Rolling Offer",
"type": "RollingOffer",
"active": true,
"active": true,
"displayName": "My Rolling Offer",
"description": "This is my rolling offer description.",
"segments": [
"New User"
],
"offerUi": null,
"productsSequence": [
{
"index": 1,
"products": [
{
"publisherProductId": "613",
"name": "Sword",
"textFontColorHex": "#f60404",
"type": "Quantity",
"prefix": "$",
"suffix": "M",
"priority": "Main",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/25cb7861ec8924a6b69a0f59/408472.png"
},
{
"type": "productPrefix",
"url": ""
}
],
"createdAt": "2024-03-01T10:14:34.142Z",
"updatedAt": "2025-02-05T13:20:50.759Z",
"displayName": "Sword",
"productId": "25e1aa8a7ef37e0d94b16fdf"
}
],
"priceInUsdCents": 5000
},
{
"index": 2,
"products": [
{
"product": {
"publisherProductId": "614",
"name": "Boost",
"textFontColorHex": "#bfc6e8",
"type": "Quantity",
"prefix": "+",
"suffix": "🎉",
"priority": "Sub",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/25cb7861ec8924a6b69a0f59/1730204644395__99c7d8e4-4658-49db-ac4f-501ab93fee9a"
},
{
"type": "productPrefix",
"url": ""
}
],
"displayName": "Boost",
"createdAt": "2024-10-29T12:24:23.083Z",
"updatedAt": "2025-01-16T09:38:15.446Z",
"productId": "6720d3f7aaca102ce5fb0ce2"
}
}
],
"priceInUsdCents": 3000
}
],
"priority": 1,
"schedule": {
"permanent": false,
"timeFrames": [
{
"startTime": "2025-06-22T12:05:00.000Z",
"endTime": "2025-06-22T12:10:00.000Z",
"notes": "",
"id": "68078610fb23b166fb160469"
}
]
},
"productSale": {
"type": "percentage",
"sale": 100
},
"priceDiscount": {
"type": "percentage",
"discount": 20
},
"createdAt": "2025-04-06T10:00:44.528Z",
"updatedAt": "2025-04-06T10:00:44.528Z"
}
}
Retrieves a single offer or a list of offers based on the specified query parameters.
curl -X GET \
'https://api.appcharge.com/v2/offer' \
-H 'Content-Type: application/json' \
-H 'x-publisher-token: <x-publisher-token>' \
-d '{
}'
{
"totalCount": 2,
"offers": [
{
"publisherId": "35nb7861ec9924a6b69a0fe59",
"publisherOfferId": "post-purchase-1",
"name": "Purchase Reward Offer",
"displayName": "Purchase Reward Offer",
"description": "Post purchase offer for VIP players.",
"type": "PopUp",
"subType": "PostPurchase",
"active": true,
"segments": [],
"offerUi": {
"offerUiId": "68b41c5aa1c5b1a284737e9b",
"active": true,
"offerUiType": "PopUp",
"name": "popup",
"description": "description",
"backgroundImage": "https://media.appcharge.com/media/35nb7861ec9924a6b69a0fe59/2755379465856__fa883338-5790-47c8-a6a0-23cb43db58844",
"externalId": "popup"
},
"productsSequence": [
{
"index": 1,
"products": [
{
"product": {
"publisherProductId": "TreasureChest",
"name": "Treasure Chest",
"type": "Quantity",
"prefix": "$",
"suffix": "M",
"priority": "Main",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/35nb7861ec9924a6b69a0fe59/2208472.png"
},
{
"type": "productPrefix",
"url": ""
}
],
"displayName": "Treasure Chest"
}
}
]
}
],
"priority": 1,
"showAfter": "purchase",
"triggers": [
{
"type": "event",
"eventName": "purchase",
"every": 1,
"rules": []
}
],
"createdAt": "2025-09-01T14:16:09.499Z",
"updatedAt": "2025-09-01T14:16:09.499Z",
"offerId": "68b5aaa9b73fceb9ffc26f9b"
},
{
"publisherId": "35nb7861ec9924a6b69a0fe59",
"offerId": "726cff96123a8717",
"publisherOfferId": "rolling-offer-1",
"name": "My Rolling Offer",
"type": "RollingOffer",
"active": true,
"active": true,
"displayName": "My Rolling Offer",
"description": "This is my rolling offer description.",
"segments": [
"New User"
],
"offerUi": null,
"productsSequence": [
{
"index": 1,
"products": [
{
"publisherProductId": "613",
"name": "Sword",
"textFontColorHex": "#f60404",
"type": "Quantity",
"prefix": "$",
"suffix": "M",
"priority": "Main",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/25cb7861ec8924a6b69a0f59/408472.png"
},
{
"type": "productPrefix",
"url": ""
}
],
"createdAt": "2024-03-01T10:14:34.142Z",
"updatedAt": "2025-02-05T13:20:50.759Z",
"displayName": "Sword",
"productId": "25e1aa8a7ef37e0d94b16fdf"
}
],
"priceInUsdCents": 5000
},
{
"index": 2,
"products": [
{
"product": {
"publisherProductId": "614",
"name": "Boost",
"textFontColorHex": "#bfc6e8",
"type": "Quantity",
"prefix": "+",
"suffix": "🎉",
"priority": "Sub",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/25cb7861ec8924a6b69a0f59/1730204644395__99c7d8e4-4658-49db-ac4f-501ab93fee9a"
},
{
"type": "productPrefix",
"url": ""
}
],
"displayName": "Boost",
"createdAt": "2024-10-29T12:24:23.083Z",
"updatedAt": "2025-01-16T09:38:15.446Z",
"productId": "6720d3f7aaca102ce5fb0ce2"
}
}
],
"priceInUsdCents": 3000
}
],
"priority": 1,
"schedule": {
"permanent": false,
"timeFrames": [
{
"startTime": "2025-06-22T12:05:00.000Z",
"endTime": "2025-06-22T12:10:00.000Z",
"notes": "",
"id": "68078610fb23b166fb160469"
}
]
},
"productSale": {
"type": "percentage",
"sale": 100
},
"priceDiscount": {
"type": "percentage",
"discount": 20
},
"createdAt": "2025-04-06T10:00:44.528Z",
"updatedAt": "2025-04-06T10:00:44.528Z"
}
}
curl -X GET \
'https://api.appcharge.com/v2/offer' \
-H 'Content-Type: application/json' \
-H 'x-publisher-token: <x-publisher-token>' \
-d '{
}'
{
"totalCount": 2,
"offers": [
{
"publisherId": "35nb7861ec9924a6b69a0fe59",
"publisherOfferId": "post-purchase-1",
"name": "Purchase Reward Offer",
"displayName": "Purchase Reward Offer",
"description": "Post purchase offer for VIP players.",
"type": "PopUp",
"subType": "PostPurchase",
"active": true,
"segments": [],
"offerUi": {
"offerUiId": "68b41c5aa1c5b1a284737e9b",
"active": true,
"offerUiType": "PopUp",
"name": "popup",
"description": "description",
"backgroundImage": "https://media.appcharge.com/media/35nb7861ec9924a6b69a0fe59/2755379465856__fa883338-5790-47c8-a6a0-23cb43db58844",
"externalId": "popup"
},
"productsSequence": [
{
"index": 1,
"products": [
{
"product": {
"publisherProductId": "TreasureChest",
"name": "Treasure Chest",
"type": "Quantity",
"prefix": "$",
"suffix": "M",
"priority": "Main",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/35nb7861ec9924a6b69a0fe59/2208472.png"
},
{
"type": "productPrefix",
"url": ""
}
],
"displayName": "Treasure Chest"
}
}
]
}
],
"priority": 1,
"showAfter": "purchase",
"triggers": [
{
"type": "event",
"eventName": "purchase",
"every": 1,
"rules": []
}
],
"createdAt": "2025-09-01T14:16:09.499Z",
"updatedAt": "2025-09-01T14:16:09.499Z",
"offerId": "68b5aaa9b73fceb9ffc26f9b"
},
{
"publisherId": "35nb7861ec9924a6b69a0fe59",
"offerId": "726cff96123a8717",
"publisherOfferId": "rolling-offer-1",
"name": "My Rolling Offer",
"type": "RollingOffer",
"active": true,
"active": true,
"displayName": "My Rolling Offer",
"description": "This is my rolling offer description.",
"segments": [
"New User"
],
"offerUi": null,
"productsSequence": [
{
"index": 1,
"products": [
{
"publisherProductId": "613",
"name": "Sword",
"textFontColorHex": "#f60404",
"type": "Quantity",
"prefix": "$",
"suffix": "M",
"priority": "Main",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/25cb7861ec8924a6b69a0f59/408472.png"
},
{
"type": "productPrefix",
"url": ""
}
],
"createdAt": "2024-03-01T10:14:34.142Z",
"updatedAt": "2025-02-05T13:20:50.759Z",
"displayName": "Sword",
"productId": "25e1aa8a7ef37e0d94b16fdf"
}
],
"priceInUsdCents": 5000
},
{
"index": 2,
"products": [
{
"product": {
"publisherProductId": "614",
"name": "Boost",
"textFontColorHex": "#bfc6e8",
"type": "Quantity",
"prefix": "+",
"suffix": "🎉",
"priority": "Sub",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/25cb7861ec8924a6b69a0f59/1730204644395__99c7d8e4-4658-49db-ac4f-501ab93fee9a"
},
{
"type": "productPrefix",
"url": ""
}
],
"displayName": "Boost",
"createdAt": "2024-10-29T12:24:23.083Z",
"updatedAt": "2025-01-16T09:38:15.446Z",
"productId": "6720d3f7aaca102ce5fb0ce2"
}
}
],
"priceInUsdCents": 3000
}
],
"priority": 1,
"schedule": {
"permanent": false,
"timeFrames": [
{
"startTime": "2025-06-22T12:05:00.000Z",
"endTime": "2025-06-22T12:10:00.000Z",
"notes": "",
"id": "68078610fb23b166fb160469"
}
]
},
"productSale": {
"type": "percentage",
"sale": 100
},
"priceDiscount": {
"type": "percentage",
"discount": 20
},
"createdAt": "2025-04-06T10:00:44.528Z",
"updatedAt": "2025-04-06T10:00:44.528Z"
}
}
The publisher token
Type of offer.
Available options: Bundle, SpecialOffer, PopUp, RollingOffer, CheckoutLink
Maximum number of items to return in the results.
0 <= x <= 500Number of items to skip.
x >= 0The unique identifier for the offer. Use this property to retrieve specific offers. To retrieve multiple offers, separate them with a ,.
Offers successfully retrieved.
List of offers.
Show child attributes
Publisher ID.
The SKU of the offer.
The offer ID provided by the publisher. This is the offer's External ID value in the Publisher Dashboard.
The name of the offer. Must be a minimum of 3 characters.
The display name of the offer.
The description of the offer (conditionally returned).
Type of offer.
Available options: Bundle, SpecialOffer, PopUp, RollingOffer, CheckoutLink
Details on the offer design, as configured in the Publisher Dashboard.
Show child attributes
The ID of the offer design, as displayed in the Publisher Dashboard.
The SKU of the offer design, as defined in the Publisher Dashboard.
Whether the offer is active.
The type of offer design.
The name of the offer design, as defined in the Publisher Dashboard.
The description of the offer design, as defined in the Publisher Dashboard.
The background image of the offer design, as defined in the Publisher Dashboard.
Details on the offer template and design.
Show child attributes
The template type, as configured in the Publisher Dashboard.
The title of the offer, as configured in the Publisher Dashboard.
The font size of the offer title, as configured in the Publisher Dashboard.
The font weight of the offer title, as configured in the Publisher Dashboard.
Details on the font color of the offer title as configured in the Publisher Dashboard. If the font color is set to linear, direction will be returned, as well as both 'colorOne' and 'colorTwo'.
Show child attributes
The font color of the offer title.
The second font color of the offer title. Relevant only if the font color is set to linear.
The direction of the linear gradient. Relevant only if the font color is set to linear.
Details on the background color of the offer title as configured in the Publisher Dashboard. If the background color is set to linear, the direction will be returned along with ‘colorOne’ and ‘colorTwo’.
Show child attributes
The background color of the offer title.
The second background color of the offer title. Relevant only if the background color is set to linear.
The direction of the linear gradient. Relevant only if the background color is set to linear.
Sale details for products in the offer. The sale will only be applied on the first offer.
Whether the offer is active.
List of player segments that this offer applies to (e.g., ["NewUser", "BigSpender"]).
Tab ID in the web store.
The sequence of products included in the offer.
Show child attributes
The order of the product in the offer.
The amount of times the player can purchase or collect the offer.
The price of the product in cents. The value must be either 0 (free), or by minimum 80 cents.
List of products in the offer.
Show child attributes
The quantity of the product in the offer.
Specifies the display priority of a product within the offer. Either Main or Sub.
Details on the product design.
Show child attributes
The SKU of the product, as configured in the Publisher Dashboard.
The name of the product, as configured in the Publisher Dashboard.
The font color of the product display name, as configured in the Publisher Dashboard.
Type of product, either quantity or time.
quantity, time The prefix of the product, as configured in the Publisher Dashboard. This is the text that appears before the product amount.
The suffix of the product, as configured in the Publisher Dashboard. This is the text that appears after the product amount.
Specifies the display priority of a product within the offer.
Main, Sub Details on the images uploaded for this product in the Publisher Dashboard.
Show child attributes
Date the product was created.
Date the product was updated.
A unique product ID number automatically generated by Appcharge.
Whether the offer will restart after completion.
The priority level of the offer. The priority starts from 1, where 1 is the highest priority.
An array of objects that define the conditions for triggering the offer.
Date the offer was created.
Date the offer was updated.
Was this page helpful?