POST v1/coupons/Validate

Documentation for 'Validate'.

Request Information

Parameters

NameDescriptionAdditional information
entity 
Documentation for 'entity'.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
Click to beautify! 
{
  "couponCode": "sample string 1",
  "planId": 2,
  "customerId": 1
}

application/xml, text/xml

Sample:
Click to beautify! 
<CouponValidation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Post">
  <CouponCode>sample string 1</CouponCode>
  <CustomerId>1</CustomerId>
  <PlanId>2</PlanId>
</CouponValidation>

application/x-www-form-urlencoded

Sample:
Click to beautify!

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:
Click to beautify! 
{
  "valid": true,
  "reason": "sample string 2"
}

application/xml, text/xml

Sample:
Click to beautify! 
<Validation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Get">
  <Reason>sample string 2</Reason>
  <Valid>true</Valid>
</Validation>