Coupons

With Rebill's Coupons API, you can access the whole information and also manually edit specific data of your customers.

GET/v2/coupons

Get coupons

Get the list of all your coupons.

Optional Query Parameters

orderstring

searchstring

pagestring

takejson

Response

  {
  "data": [
      {
          "id": "xxxxxx-f1d6-46d3-xxxx-9c7addad4252",
          "name": "test_coupon",
          "description": "TEST",
          "durationType": "forever",
          "durationInCycles": null,
          "totalRedemptions": 0,
          "archive": false,
          "discountedAmount": null,
          "appliesTo": null,
          "currenciesDiscountOptions": null,
          "discountCurrency": null,
          "discountType": "percentage",
          "maxRedemptions": null,
          "metadata": null,
          "discountedPercentage": "10",
          "redeemUpTo": null,
          "redemptionPerUserType": "unlimited",
          "status": "Active"
      },
      {
          "id": "xxxxxxx-a5c0-4f12-xx-085ba85cc85d",
          "name": "dos",
          "description": "test dos",
          "durationType": "forever",
          "durationInCycles": null,
          "totalRedemptions": 0,
          "archive": false,
          "discountedAmount": null,
          "appliesTo": null,
          "currenciesDiscountOptions": null,
          "discountCurrency": null,
          "discountType": "percentage",
          "maxRedemptions": null,
          "metadata": null,
          "discountedPercentage": "50",
          "redeemUpTo": null,
          "redemptionPerUserType": "unlimited",
          "status": "Active"
      }
  ],
  "meta": {
      "page": 1,
      "take": 10,
      "itemCount": 2,
      "pageCount": 1,
      "hasPreviousPage": false,
      "hasNextPage": false
  }
}

GET/v2/coupons/{id}

Get Coupon by ID

Retrieve detailed information about a specific coupon by its unique ID.

Required Path Parameters

idstringrequired

Response

    {
        "id": "xxxxxx-f1d6-46d3-xxxx-9c7addad4252",
        "name": "test_coupon",
        "description": "TEST",
        "durationType": "forever",
        "durationInCycles": null,
        "totalRedemptions": 0,
        "archive": false,
        "discountedAmount": null,
        "appliesTo": null,
        "currenciesDiscountOptions": null,
        "discountCurrency": null,
        "discountType": "percentage",
        "maxRedemptions": null,
        "metadata": null,
        "discountedPercentage": "10",
        "redeemUpTo": null,
        "redemptionPerUserType": "unlimited",
        "status": "Active"
    }

GET/v2/coupons/allowed-to-apply

Get allowed coupons by item ID

Retrieve coupons that can be applied to a specific item. This endpoint helps identify which coupons are applicable for different scenarios.

Optional Query Parameters

itemIdstring

discountCurrencystring

Response

  {
      "data": [
          {
              "id": "xxxxxx-f1d6-46d3-xxxx-9c7addad4252",
              "name": "test_coupon",
              "description": "TEST",
              "durationType": "forever",
              "durationInCycles": null,
              "totalRedemptions": 0,
              "archive": false,
              "discountedAmount": null,
              "appliesTo": null,
              "currenciesDiscountOptions": null,
              "discountCurrency": null,
              "discountType": "percentage",
              "maxRedemptions": null,
              "metadata": null,
              "discountedPercentage": "10",
              "redeemUpTo": null,
              "redemptionPerUserType": "unlimited",
              "status": "Active"
          },
          {
              "id": "xxxxxxx-a5c0-4f12-xx-085ba85cc85d",
              "name": "dos",
              "description": "test dos",
              "durationType": "forever",
              "durationInCycles": null,
              "totalRedemptions": 0,
              "archive": false,
              "discountedAmount": null,
              "appliesTo": null,
              "currenciesDiscountOptions": null,
              "discountCurrency": null,
              "discountType": "percentage",
              "maxRedemptions": null,
              "metadata": null,
              "discountedPercentage": "50",
              "redeemUpTo": null,
              "redemptionPerUserType": "unlimited",
              "status": "Active"
          }
      ]
  }

POST/v2/coupons

Create a Coupon

Create a new coupon for your organization. Customize it to fit your sales campaigns or customer discounts.

Body Parameters

namestringrequired

descriptionstringrequired

redeemUpTodaterequired

maxRedemptionsnumberrequired

durationTypeenumrequired

durationInCyclesnumber

discountTypeenumrequired

discountedPercentagestring

discountedAmountstring

discountCurrencystring

couponCodesarray of strings

Response

  {
      "id": "xxxx-42bf-4fc8-bb76-f3ab0d93ba54",
      "name": "Coupon Test POST",
      "description": "OFF25",
      "durationType": "once",
      "durationInCycles": 1,
      "totalRedemptions": 0,
      "archive": false,
      "discountedAmount": null,
      "currenciesDiscountOptions": null,
      "discountType": "percentage",
      "maxRedemptions": null,
      "discountedPercentage": "15",
      "redeemUpTo": "2024-04-21T15:40:04.970Z",
      "redemptionPerUserType": "unlimited",
      "status": "Active"
  }

PUT/v2/coupons/{id}

Update a Coupon

Update existing coupon details in your organization. Provide only the properties that need to be changed.

Required Path Parameters

idstringrequired

Body Parameters

namestring

descriptionstring

redeemUpTodate

maxRedemptionsnumber

durationTypeenum

durationInCyclesnumber

discountTypeenum

redemptionPerUserTypeenum

discountedPercentagestring

discountedAmountstring

discountCurrencystring

Response

  {
      "id": "xxxx-42bf-4fc8-bb76-f3ab0d93ba54",
      "name": "Updated Coupon Name",
      "description": "OFF25",
      "durationType": "once",
      "durationInCycles": 1,
      "totalRedemptions": 0,
      "archive": false,
      "discountedAmount": null,
      "currenciesDiscountOptions": null,
      "discountType": "percentage",
      "maxRedemptions": null,
      "discountedPercentage": "15",
      "redeemUpTo": "2024-04-21T15:40:04.970Z",
      "redemptionPerUserType": "unlimited",
      "status": "Active"
  }