DELETE api/subscription/refund/campaign/display/{id}

Cancels a pre-purchased display campaign's subscription and issueds a refund for accrued spend. This will only work for campaigns that have not launched.

Request Information

Authentication Method

Partner/Account Authentication

URI Parameters

NameDescriptionTypeAdditional information
id

The Id of the Display campaign for which you would like to intiate a refund

 integer

Required

Body Parameters

None.

Response Information

Successful Response:

Resource Description

CampaignRefund
NameDescriptionTypeAdditional information
charge

List of reunded items

 Campaign Charge Detail

 
campaignInfo

Current subscription information after refund

 Campaign Subscription

 

Response Formats

application/json, text/json

Sample: 
{
  "charge": {
    "items": [
      {
        "name": "Silver Spend",
        "price": -1500.0,
        "currency": "USD",
        "type": "SearchCampaignFee",
        "partnerSKU": null,
        "exchangeRate": null
      }
    ],
    "termRatio": 0.0
  },
  "campaignInfo": {
    "id": 111,
    "name": "My campaign",
    "status": "PrepurchaseCancelled",
    "type": "Search",
    "endDate": "2025-06-30T02:49:26.5737267+00:00",
    "subscription": {
      "budget": 1500.0,
      "currency": "USD",
      "active": false,
      "type": "SearchCampaign",
      "billingType": "Automatic",
      "nextCharge": "2025-07-30T02:49:26.5737267+00:00"
    },
    "partnerSKUs": null,
    "budgetLockExpiration": null,
    "subscriptionExpiration": null
  }
}

application/xml, text/xml

Sample: 
<CampaignRefund xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.ReturnModels">
  <campaignInfo>
    <budgetLockExpiration i:nil="true" />
    <endDate>2025-06-30T02:49:26.5737267+00:00</endDate>
    <id>111</id>
    <name>My campaign</name>
    <partnerSKUs i:nil="true" />
    <status>PrepurchaseCancelled</status>
    <subscription>
      <active>false</active>
      <billingType>Automatic</billingType>
      <budget>1500</budget>
      <currency>USD</currency>
      <nextCharge>2025-07-30T02:49:26.5737267+00:00</nextCharge>
      <type>SearchCampaign</type>
    </subscription>
    <subscriptionExpiration i:nil="true" />
    <type>Search</type>
  </campaignInfo>
  <charge>
    <items>
      <ChargeItem>
        <currency>USD</currency>
        <exchangeRate i:nil="true" />
        <name>Silver Spend</name>
        <partnerSKU i:nil="true" />
        <price>-1500</price>
        <type>SearchCampaignFee</type>
      </ChargeItem>
    </items>
    <termRatio>0</termRatio>
  </charge>
</CampaignRefund>