GetCouponInfo Service Operation - Customer Billing

Gets information about coupons associated with a customer ID.

Request Elements

The GetCouponInfoRequest 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
CustomerId	The customer ID.	long

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 GetCouponInfoResponse 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
CouponInfoData	A list of coupon info data objects.	CouponInfoData array

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">GetCouponInfo</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetCouponInfoRequest xmlns="https://bingads.microsoft.com/Billing/v13">
      <CustomerId>ValueHere</CustomerId>
    </GetCouponInfoRequest>
  </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>
    <GetCouponInfoResponse xmlns="https://bingads.microsoft.com/Billing/v13">
      <CouponInfoData xmlns:e19="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e19:CouponInfoData>
          <e19:AccountId>ValueHere</e19:AccountId>
          <e19:CouponId d4p1:nil="false">ValueHere</e19:CouponId>
          <e19:ClaimDate d4p1:nil="false">ValueHere</e19:ClaimDate>
          <e19:Status d4p1:nil="false">ValueHere</e19:Status>
          <e19:RedemptionDate d4p1:nil="false">ValueHere</e19:RedemptionDate>
          <e19:ExpirationDate d4p1:nil="false">ValueHere</e19:ExpirationDate>
          <e19:PercentOff d4p1:nil="false">ValueHere</e19:PercentOff>
          <e19:CouponValue d4p1:nil="false">ValueHere</e19:CouponValue>
          <e19:UpfrontSpending d4p1:nil="false">ValueHere</e19:UpfrontSpending>
          <e19:ActiveDuration d4p1:nil="false">ValueHere</e19:ActiveDuration>
          <e19:SpendToThreshold d4p1:nil="false">ValueHere</e19:SpendToThreshold>
          <e19:StartDate d4p1:nil="false">ValueHere</e19:StartDate>
          <e19:EndDate d4p1:nil="false">ValueHere</e19:EndDate>
          <e19:Balance d4p1:nil="false">ValueHere</e19:Balance>
          <e19:CurrencyCode d4p1:nil="false">ValueHere</e19:CurrencyCode>
          <e19:FeatureId d4p1:nil="false">ValueHere</e19:FeatureId>
          <e19:CouponType d4p1:nil="false">ValueHere</e19:CouponType>
        </e19:CouponInfoData>
      </CouponInfoData>
    </GetCouponInfoResponse>
  </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<GetCouponInfoResponse> GetCouponInfoAsync(
	long customerId)
{
	var request = new GetCouponInfoRequest
	{
		CustomerId = customerId
	};

	return (await CustomerBillingService.CallAsync((s, r) => s.GetCouponInfoAsync(r), request));
}

static GetCouponInfoResponse getCouponInfo(
	java.lang.Long customerId) throws RemoteException, Exception
{
	GetCouponInfoRequest request = new GetCouponInfoRequest();

	request.setCustomerId(customerId);

	return CustomerBillingService.getService().getCouponInfo(request);
}

static function GetCouponInfo(
	$customerId)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerBillingProxy'];

	$request = new GetCouponInfoRequest();

	$request->CustomerId = $customerId;

	return $GLOBALS['CustomerBillingProxy']->GetService()->GetCouponInfo($request);
}

response=customerbilling_service.GetCouponInfo(
	CustomerId=CustomerId)

Requirements

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

Request Url

Production URL

https://clientcenter.api.bingads.microsoft.com/CustomerBilling/v13/CouponInfo/Query

Sandbox URL

https://clientcenter.api.sandbox.bingads.microsoft.com/CustomerBilling/v13/CouponInfo/Query

Request Elements

The GetCouponInfoRequest 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
CustomerId	The customer ID.	long

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 GetCouponInfoResponse 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
CouponInfoData	A list of coupon info data objects.	CouponInfoData array

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.

{
  "CustomerId": "LongValueHere"
}

Response JSON

This template was generated by a tool to show the body and header elements for the JSON response.

{
  "CouponInfoData": [
    {
      "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
    }
  ]
}

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<GetCouponInfoResponse> GetCouponInfoAsync(
	long customerId)
{
	var request = new GetCouponInfoRequest
	{
		CustomerId = customerId
	};

	return (await CustomerBillingService.CallAsync((s, r) => s.GetCouponInfoAsync(r), request));
}

static GetCouponInfoResponse getCouponInfo(
	java.lang.Long customerId) throws RemoteException, Exception
{
	GetCouponInfoRequest request = new GetCouponInfoRequest();

	request.setCustomerId(customerId);

	return CustomerBillingService.getService().getCouponInfo(request);
}

static function GetCouponInfo(
	$customerId)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerBillingProxy'];

	$request = new GetCouponInfoRequest();

	$request->CustomerId = $customerId;

	return $GLOBALS['CustomerBillingProxy']->GetService()->GetCouponInfo($request);
}

response=customerbilling_service.GetCouponInfo(
	CustomerId=CustomerId)