Skip to main content
GET
/
v2
/
offer
curl -X GET \
  'https://api.appcharge.com/v2/offer?publisherOfferIds=rolling-offer-1' \
  -H 'Content-Type: application/json' \
  -H 'x-publisher-token: <x-publisher-token>'
{
  "totalCount": 1,
  "offers": [
    {
      "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"
      ],
      "publisherTabId": "tab-1",
      "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?publisherOfferIds=rolling-offer-1' \
  -H 'Content-Type: application/json' \
  -H 'x-publisher-token: <x-publisher-token>'
{
  "totalCount": 1,
  "offers": [
    {
      "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"
      ],
      "publisherTabId": "tab-1",
      "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"
    }
  ]
}

Headers

x-publisher-token
string
required

The publisher token used for authentication.

Query Parameters

publisherOfferIds
string
required

The unique identifier for the offer. To retrieve multiple rolling offers, separate them with a comma.

Example:

"rolling-offer-1,rolling-offer-2"

Response

Rolling Offer retrieved successfully.

totalCount
number

Total number of matching offers.

offers
object[]