CouponInfoData Data Object - Customer Billing

Defines an object containing coupon info.

Syntax

XML

<xs:complexType name="CouponInfoData" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="AccountId" type="xs:int" />
    <xs:element minOccurs="0" name="CouponId" nillable="true" type="xs:int" />
    <xs:element minOccurs="0" name="ClaimDate" nillable="true" type="xs:dateTime" />
    <xs:element minOccurs="0" name="Status" nillable="true" type="xs:unsignedByte" />
    <xs:element minOccurs="0" name="RedemptionDate" nillable="true" type="xs:dateTime" />
    <xs:element minOccurs="0" name="ExpirationDate" nillable="true" type="xs:dateTime" />
    <xs:element minOccurs="0" name="PercentOff" nillable="true" type="xs:double" />
    <xs:element minOccurs="0" name="CouponValue" nillable="true" type="xs:decimal" />
    <xs:element minOccurs="0" name="UpfrontSpending" nillable="true" type="xs:decimal" />
    <xs:element minOccurs="0" name="ActiveDuration" nillable="true" type="xs:int" />
    <xs:element minOccurs="0" name="SpendToThreshold" nillable="true" type="xs:decimal" />
    <xs:element minOccurs="0" name="StartDate" nillable="true" type="xs:dateTime" />
    <xs:element minOccurs="0" name="EndDate" nillable="true" type="xs:dateTime" />
    <xs:element minOccurs="0" name="Balance" nillable="true" type="xs:decimal" />
    <xs:element minOccurs="0" name="CurrencyCode" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="FeatureId" nillable="true" type="xs:int" />
    <xs:element minOccurs="0" name="CouponType" nillable="true" type="xs:unsignedByte" />
  </xs:sequence>
</xs:complexType>

JSON

{
  "AccountId": IntValueHere,
  "ActiveDuration": IntValueHere,
  "Balance": DecimalValueHere,
  "ClaimDate": "ValueHere",
  "CouponId": IntValueHere,
  "CouponType": "ValueHere",
  "CouponValue": DecimalValueHere,
  "CurrencyCode": "ValueHere",
  "EndDate": "ValueHere",
  "ExpirationDate": "ValueHere",
  "FeatureId": IntValueHere,
  "PercentOff": DoubleValueHere,
  "RedemptionDate": "ValueHere",
  "SpendToThreshold": DecimalValueHere,
  "StartDate": "ValueHere",
  "Status": "ValueHere",
  "UpfrontSpending": DecimalValueHere
}

Elements

The CouponInfoData object has the following elements: AccountId, ActiveDuration, Balance, ClaimDate, CouponId, CouponType, CouponValue, CurrencyCode, EndDate, ExpirationDate, FeatureId, PercentOff, RedemptionDate, SpendToThreshold, StartDate, Status, UpfrontSpending.

Element	Description	Data Type
AccountId	The account ID.	int
ActiveDuration	The length of time in which the coupon may be used.	int
Balance	The balance after the coupon is applied.	decimal
ClaimDate	The coupon's claim date.	dateTime
CouponId	The coupon ID.	int
CouponType	The type of coupon.	unsignedByte
CouponValue	The coupon's value.	decimal
CurrencyCode	The currency code for the coupon.	string
EndDate	The coupon's end date.	dateTime
ExpirationDate	The coupon's expiration date.	dateTime
FeatureId	The feature ID attached to the coupon.	int
PercentOff	The coupon's discount percentage.	double
RedemptionDate	The date the coupon was redeemed.	dateTime
SpendToThreshold	The amount that must be spent before the coupon is applied.	decimal
StartDate	The coupon's start date.	dateTime
Status	The coupon's status.	unsignedByte
UpfrontSpending	The value of the upfront spending coupon.	decimal

Requirements

Service: CustomerBillingService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13/Entities

Used By

GetCouponInfo