Coupon Data Object - Customer Billing

Defines a coupon.

Syntax

<xs:complexType name="Coupon" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="CouponCode" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="ClassName" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="CouponType" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Amount" type="xs:double" />
    <xs:element minOccurs="0" name="SpendThreshold" type="xs:double" />
    <xs:element minOccurs="0" name="CurrencyCode" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="PercentOff" nillable="true" type="xs:double" />
    <xs:element minOccurs="0" name="ActiveDuration" nillable="true" type="xs:int" />
    <xs:element minOccurs="0" name="ExpirationDate" nillable="true" type="xs:dateTime" />
    <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="SendToEmail" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="SendToDate" nillable="true" type="xs:dateTime" />
    <xs:element minOccurs="0" name="IsRedeemed" type="xs:boolean" />
    <xs:element minOccurs="0" name="RedemptionInfo" nillable="true" type="tns:CouponRedemption" />
    <xs:element minOccurs="0" name="ClaimInfo" nillable="true" type="tns:CouponClaimInfo">
      <xs:annotation>
        <xs:appinfo>
          <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
        </xs:appinfo>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
</xs:complexType>

Elements

The Coupon object has the following elements: ActiveDuration, Amount, ClaimInfo, ClassName, CouponCode, CouponType, CurrencyCode, EndDate, ExpirationDate, IsRedeemed, PercentOff, RedemptionInfo, SendToDate, SendToEmail, SpendThreshold, StartDate.

Element	Description	Data Type
ActiveDuration	Active days since coupon has been redeemed. After these days, the coupon can't be consumed.	int
Amount	The value amount of the coupon. The CurrencyCode element determines the currency.	double
ClaimInfo	The AccountId, AccountNumber, and ClaimDate of the claim.	CouponClaimInfo
ClassName	The class name that the coupon was minted from.	string
CouponCode	The code that can be used to redeem the coupon.	string
CouponType	The coupon's type. Supported types include: Acquisition: Acquisition coupon is used to acquire new customers. Only new customers can redeem this coupon. Retention: Retention coupons can be used by both new and existing customers.	string
CurrencyCode	The currency of the coupon amount and spend threshold. For possible values, see Currencies.	string
EndDate	The last date that the coupon can be redeemed.	dateTime
ExpirationDate	The coupon expiration date. After this date, the coupon can't be consumed.	dateTime
IsRedeemed	Has the coupon been redeemed. Value will be true if the coupon has been redeemed, and otherwise the value is false.	boolean
PercentOff	The percent off coupon value. This is only applicable for a percentage coupon. For example, 10.0 represents a 10% discount.	double
RedemptionInfo	Contains redemption and consuming details. Returned only when the account where the coupon was redeemed bills to the coupon's owner customer.	CouponRedemption
SendToDate	The date the coupon was emailed by the DispatchCoupons operation.	dateTime
SendToEmail	The email address the coupon has been emailed by the DispatchCoupons operation.	string
SpendThreshold	The coupon can't be consumed until the account's spend reaches this threshold from the time coupon was redeemed. The CurrencyCode element determines the currency.	double
StartDate	The coupon cannot be redeemed before the start date.	dateTime

Requirements

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

Used By

SearchCoupons