PUT v1/Coupons

Request Information

URI Parameters

None.

Body Parameters

Common.Dto.Put.CouponConfiguration

Name	Type	Additional information
Name	string	Required String length: inclusive between 0 and 255
Description	string	String length: inclusive between 0 and 500
ApplyToAllPlans	boolean	None.
couponCodes	Collection of Common.Dto.Put.CouponCode	None.
Discounts	Collection of Object	None.
plans	Collection of Common.Dto.Put.CouponPlanConfiguration	None.
eligibilities	Collection of Common.Dto.Put.CouponEligibility	None.
oneTimeUse	boolean	None.
id	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "name": "sample string 1",
  "description": "sample string 2",
  "applyToAllPlans": true,
  "couponCodes": [
    {
      "code": "sample string 1",
      "remainingUsages": 1
    },
    {
      "code": "sample string 1",
      "remainingUsages": 1
    }
  ],
  "discounts": [
    {},
    {}
  ],
  "plans": [
    {
      "applyToAllProducts": true,
      "planProducts": [
        1,
        2
      ],
      "id": 2
    },
    {
      "applyToAllProducts": true,
      "planProducts": [
        1,
        2
      ],
      "id": 2
    }
  ],
  "eligibilities": [
    {
      "startDate": "2025-11-03T19:48:02.427876+00:00",
      "endDate": "2025-11-03T19:48:02.427876+00:00",
      "discounts": [
        1,
        2
      ],
      "id": 3
    },
    {
      "startDate": "2025-11-03T19:48:02.427876+00:00",
      "endDate": "2025-11-03T19:48:02.427876+00:00",
      "discounts": [
        1,
        2
      ],
      "id": 3
    }
  ],
  "oneTimeUse": true,
  "id": 5
}

Response Information

Resource Description

Common.Dto.Get.CouponConfiguration

Name	Type	Additional information
discounts	Collection of Common.Dto.Get.BaseDto	None.
eligibilities	Collection of Common.Dto.Get.CouponEligibility	None.
plans	Collection of Common.Dto.Get.CouponPlanConfiguration	None.
name	string	None.
description	string	None.
eligibilityStartDate	date	None.
eligibilityEndDate	date	None.
status	string	None.
applyToAllPlans	boolean	None.
oneTimeUse	boolean	None.
couponCodes	Collection of Common.Dto.Get.CouponCode	None.
id	integer	None.
uri	string	None.

Response Formats

application/json, text/json

Sample:

{
  "discounts": [
    {
      "id": 1,
      "uri": "sample string 2"
    },
    {
      "id": 1,
      "uri": "sample string 2"
    }
  ],
  "eligibilities": [
    {
      "startDate": "2025-11-03T19:48:02.4535338+00:00",
      "endDate": "2025-11-03T19:48:02.4535338+00:00",
      "discounts": [
        {
          "id": 1,
          "uri": "sample string 2"
        },
        {
          "id": 1,
          "uri": "sample string 2"
        }
      ]
    },
    {
      "startDate": "2025-11-03T19:48:02.4535338+00:00",
      "endDate": "2025-11-03T19:48:02.4535338+00:00",
      "discounts": [
        {
          "id": 1,
          "uri": "sample string 2"
        },
        {
          "id": 1,
          "uri": "sample string 2"
        }
      ]
    }
  ],
  "plans": [
    {
      "planName": "sample string 1",
      "applyToAllProducts": true,
      "planProducts": [
        {
          "planProductId": 1,
          "planProductName": "sample string 2",
          "id": 3,
          "uri": "sample string 4"
        },
        {
          "planProductId": 1,
          "planProductName": "sample string 2",
          "id": 3,
          "uri": "sample string 4"
        }
      ],
      "id": 3,
      "uri": "sample string 4"
    },
    {
      "planName": "sample string 1",
      "applyToAllProducts": true,
      "planProducts": [
        {
          "planProductId": 1,
          "planProductName": "sample string 2",
          "id": 3,
          "uri": "sample string 4"
        },
        {
          "planProductId": 1,
          "planProductName": "sample string 2",
          "id": 3,
          "uri": "sample string 4"
        }
      ],
      "id": 3,
      "uri": "sample string 4"
    }
  ],
  "name": "sample string 1",
  "description": "sample string 2",
  "eligibilityStartDate": "2025-11-03T19:48:02.4535338+00:00",
  "eligibilityEndDate": "2025-11-03T19:48:02.4535338+00:00",
  "status": "sample string 3",
  "applyToAllPlans": true,
  "oneTimeUse": true,
  "couponCodes": [
    {
      "id": 1,
      "code": "sample string 2",
      "timesUsed": 3,
      "remainingUsages": 1
    },
    {
      "id": 1,
      "code": "sample string 2",
      "timesUsed": 3,
      "remainingUsages": 1
    }
  ],
  "id": 6,
  "uri": "sample string 7"
}