GET api/variablecopaycoupons

Gets a collection of VariableCopayCoupon/Copay resources for a Group Plan

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A list of variableCopayCoupon details

Collection of VariableCopayCouponModel

Name	Description	Type	Additional information
Description	Gets or sets the Description	string	None.
EffectiveStartDate	Gets or sets the Effective Start Date	date	None.
EffectiveEndDate	Gets or sets the Effective End Date	date	None.
Active	Gets or sets the Active status	boolean	None.
CouponTotalValueAccum	Gets or sets the Coupon Total Value for the Accumulator program	decimal number	None.
CouponTotalValueMaximizer	Gets or sets the Coupon Total Value for the Maximizer program	decimal number	None.
MaxValuePerFillAccum	Gets or sets the Max Value Per Fill for the Accumulator program	decimal number	None.
MaxValuePerFillMaximizer	Gets or sets the Max Value Per Fill for the Maximizer program	decimal number	None.
CouponDurationDays	Gets or sets the Coupon Duration Days	integer	None.
CouponFee	Gets or sets the Coupon Fee	decimal number	None.
MinAge	Gets or sets the Minimum Age	byte	None.
MaxAge	Gets or sets the Maximum Age	byte	None.
MaxFills	Gets or sets the Maximum Fills	integer	None.
SSVersionID	Gets or sets the SSVersionID	integer	None.
VariableCopayCouponDrugs	Gets or sets the Variable Copay Coupon Drug list	Collection of VariableCopayCouponDrugModel	None.
Url	Gets or sets the link representing a link back to the resource	string	None.
ID	Gets or sets the identifier for the resource	integer	None.

Response Formats

application/json, text/json, application/json-patch+json

Sample:

[
  {
    "url": "sample string 10",
    "id": 11,
    "description": "sample string 2",
    "effectiveStartDate": "2025-12-09T20:14:46.0407332-06:00",
    "effectiveEndDate": "2025-12-09T20:14:46.0407332-06:00",
    "active": true,
    "couponTotalValueAccum": 6.0,
    "couponTotalValueMaximizer": 7.0,
    "maxValuePerFillAccum": 1.0,
    "maxValuePerFillMaximizer": 1.0,
    "couponDurationDays": 8,
    "couponFee": 9.0,
    "minAge": 64,
    "maxAge": 64,
    "maxFills": 1,
    "ssVersionID": 1,
    "variableCopayCouponDrugs": [
      {
        "url": "sample string 4",
        "id": 5,
        "genericProductIdentifier": "sample string 2",
        "active": true
      },
      {
        "url": "sample string 4",
        "id": 5,
        "genericProductIdentifier": "sample string 2",
        "active": true
      }
    ]
  },
  {
    "url": "sample string 10",
    "id": 11,
    "description": "sample string 2",
    "effectiveStartDate": "2025-12-09T20:14:46.0407332-06:00",
    "effectiveEndDate": "2025-12-09T20:14:46.0407332-06:00",
    "active": true,
    "couponTotalValueAccum": 6.0,
    "couponTotalValueMaximizer": 7.0,
    "maxValuePerFillAccum": 1.0,
    "maxValuePerFillMaximizer": 1.0,
    "couponDurationDays": 8,
    "couponFee": 9.0,
    "minAge": 64,
    "maxAge": 64,
    "maxFills": 1,
    "ssVersionID": 1,
    "variableCopayCouponDrugs": [
      {
        "url": "sample string 4",
        "id": 5,
        "genericProductIdentifier": "sample string 2",
        "active": true
      },
      {
        "url": "sample string 4",
        "id": 5,
        "genericProductIdentifier": "sample string 2",
        "active": true
      }
    ]
  }
]