GET v1/coupons/GetCouponWithFullDiscountsAndPlans/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

Common.Dto.Get.CouponConfigurationWithFullDiscountsAndPlans

Name	Type	Additional information
discounts	Collection of Common.Dto.Get.DiscountConfiguration	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": [
    {
      "name": "sample string 1",
      "description": "sample string 2",
      "code": "sample string 3",
      "discountType": "sample string 4",
      "remainingUsagesUntilStart": 5,
      "remainingUsage": 1,
      "amount": 6.0,
      "status": "sample string 7",
      "frequencyOverrides": [
        {
          "interval": "sample string 1",
          "numberOfIntervals": 2,
          "discountType": "sample string 3",
          "remainingUsagesUntilStart": 4,
          "remainingUsage": 1,
          "amount": 5.0
        },
        {
          "interval": "sample string 1",
          "numberOfIntervals": 2,
          "discountType": "sample string 3",
          "remainingUsagesUntilStart": 4,
          "remainingUsage": 1,
          "amount": 5.0
        }
      ],
      "netsuiteItemId": "sample string 8",
      "id": 9,
      "uri": "sample string 10"
    },
    {
      "name": "sample string 1",
      "description": "sample string 2",
      "code": "sample string 3",
      "discountType": "sample string 4",
      "remainingUsagesUntilStart": 5,
      "remainingUsage": 1,
      "amount": 6.0,
      "status": "sample string 7",
      "frequencyOverrides": [
        {
          "interval": "sample string 1",
          "numberOfIntervals": 2,
          "discountType": "sample string 3",
          "remainingUsagesUntilStart": 4,
          "remainingUsage": 1,
          "amount": 5.0
        },
        {
          "interval": "sample string 1",
          "numberOfIntervals": 2,
          "discountType": "sample string 3",
          "remainingUsagesUntilStart": 4,
          "remainingUsage": 1,
          "amount": 5.0
        }
      ],
      "netsuiteItemId": "sample string 8",
      "id": 9,
      "uri": "sample string 10"
    }
  ],
  "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-05-21T09:59:47.2292433+00:00",
  "eligibilityEndDate": "2025-05-21T09:59:47.2292433+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"
}