RedeemCoupon Service Operation - Customer Billing
Redeems a coupon to the specified account.
Note
Only a user of the account's bill to customer with Super Admin or Standard credentials can redeem coupon. For more information, see the User Roles technical guide.
Request Elements
The RedeemCouponRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
| Element | Description | Data Type |
|---|---|---|
| AccountId | The identifier of the account to which the coupon is redeemed. | long |
| CouponCode | The code of coupon to redeem. | string |
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| AuthenticationToken | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
string |
| Password | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
| UserName | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
Response Elements
The RedeemCouponResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| RedemptionDate | The date and time that the coupon was redeemed. | dateTime |
Response Header Elements
| Element | Description | Data Type |
|---|---|---|
| TrackingId | The identifier of the log entry that contains the details of the API call. | string |
Request SOAP
This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/Billing/v13">
<Action mustUnderstand="1">RedeemCoupon</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<RedeemCouponRequest xmlns="https://bingads.microsoft.com/Billing/v13">
<AccountId>ValueHere</AccountId>
<CouponCode i:nil="false">ValueHere</CouponCode>
</RedeemCouponRequest>
</s:Body>
</s:Envelope>
Response SOAP
This template was generated by a tool to show the order of the body and header elements for the SOAP response.
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/Billing/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<RedeemCouponResponse xmlns="https://bingads.microsoft.com/Billing/v13">
<RedemptionDate>ValueHere</RedemptionDate>
</RedeemCouponResponse>
</s:Body>
</s:Envelope>
Code Syntax
The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
public async Task<RedeemCouponResponse> RedeemCouponAsync(
long accountId,
string couponCode)
{
var request = new RedeemCouponRequest
{
AccountId = accountId,
CouponCode = couponCode
};
return (await CustomerBillingService.CallAsync((s, r) => s.RedeemCouponAsync(r), request));
}
static RedeemCouponResponse redeemCoupon(
java.lang.Long accountId,
java.lang.String couponCode) throws RemoteException, Exception
{
RedeemCouponRequest request = new RedeemCouponRequest();
request.setAccountId(accountId);
request.setCouponCode(couponCode);
return CustomerBillingService.getService().redeemCoupon(request);
}
static function RedeemCoupon(
$accountId,
$couponCode)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerBillingProxy'];
$request = new RedeemCouponRequest();
$request->AccountId = $accountId;
$request->CouponCode = $couponCode;
return $GLOBALS['CustomerBillingProxy']->GetService()->RedeemCoupon($request);
}
response=customerbilling_service.RedeemCoupon(
AccountId=AccountId,
CouponCode=CouponCode)
Requirements
Service: CustomerBillingService.svc v13
Namespace: https://bingads.microsoft.com/Billing/v13
Request Url
https://clientcenter.api.bingads.microsoft.com/CustomerBilling/v13/Coupon/Redeem
Request Elements
The RedeemCouponRequest object defines the body and header elements of the service operation request.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
| Element | Description | Data Type |
|---|---|---|
| AccountId | The identifier of the account to which the coupon is redeemed. | long |
| CouponCode | The code of coupon to redeem. | string |
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| Authorization | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication. For more information see Authentication with OAuth. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
string |
| Password | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
| UserName | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
Response Elements
The RedeemCouponResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response JSON.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| RedemptionDate | The date and time that the coupon was redeemed. | dateTime |
Response Header Elements
| Element | Description | Data Type |
|---|---|---|
| TrackingId | The identifier of the log entry that contains the details of the API call. | string |
Request JSON
This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
{
"AccountId": "LongValueHere",
"CouponCode": "ValueHere"
}
Response JSON
This template was generated by a tool to show the body and header elements for the JSON response.
{
"RedemptionDate": "ValueHere"
}
Code Syntax
To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
public async Task<RedeemCouponResponse> RedeemCouponAsync(
long accountId,
string couponCode)
{
var request = new RedeemCouponRequest
{
AccountId = accountId,
CouponCode = couponCode
};
return (await CustomerBillingService.CallAsync((s, r) => s.RedeemCouponAsync(r), request));
}
static RedeemCouponResponse redeemCoupon(
java.lang.Long accountId,
java.lang.String couponCode) throws RemoteException, Exception
{
RedeemCouponRequest request = new RedeemCouponRequest();
request.setAccountId(accountId);
request.setCouponCode(couponCode);
return CustomerBillingService.getService().redeemCoupon(request);
}
static function RedeemCoupon(
$accountId,
$couponCode)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerBillingProxy'];
$request = new RedeemCouponRequest();
$request->AccountId = $accountId;
$request->CouponCode = $couponCode;
return $GLOBALS['CustomerBillingProxy']->GetService()->RedeemCoupon($request);
}
response=customerbilling_service.RedeemCoupon(
AccountId=AccountId,
CouponCode=CouponCode)