DELETE api/subscription/cancel/campaign/search

Cancels a given search campaign's subscription. The last day of the campaign will be determined by the cancellation type.

Request Information

Authentication Method

Partner/Account Authentication

URI Parameters

None.

Body Parameters

Search Campaign Subscription (Delete)

Name	Description	Type	Additional information
campaignId	Id of campaign whose subscription should be cnacelled	integer	Required
cancelType	Id of campaign whose subscription should be cnacelled	CancellationType	Required
subscriptionExpiration	Optional expiration date to define when the subscription cancellation cannot be simply undone via the UI campaign will go back to using a purchase action. This only affects UI actions.	string

Request Formats

application/json, text/json

Sample:

{
  "campaignId": 1234,
  "cancelType": "EndOfCycle",
  "subscriptionExpiration": "30/07/2025 02:49:26+00:00"
}

application/xml, text/xml

Sample:

<SearchCampaignSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.DeleteModels">
  <campaignId>1234</campaignId>
  <cancelType>EndOfCycle</cancelType>
  <subscriptionExpiration>30/07/2025 02:49:26+00:00</subscriptionExpiration>
</SearchCampaignSubscription>

Response Information

Successful Response:

Resource Description

Campaign Subscription

Name	Description	Type	Additional information
id		integer
name		string
status		string
type		string
endDate		date
subscription		Subscription Detail
partnerSKUs		Collection of Partner Sku
budgetLockExpiration		date
subscriptionExpiration		date

Response Formats

application/json, text/json

Sample:

{
  "id": 111,
  "name": "My campaign",
  "status": "Active",
  "type": "Search",
  "endDate": null,
  "subscription": {
    "budget": 1500.0,
    "currency": "USD",
    "active": true,
    "type": "SearchCampaign",
    "billingType": "Automatic",
    "nextCharge": "2025-07-30T02:49:26.5580935+00:00"
  },
  "partnerSKUs": null,
  "budgetLockExpiration": null,
  "subscriptionExpiration": "2025-07-30T02:49:26.5580935+00:00"
}

application/xml, text/xml

Sample:

<CampaignSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.ReturnModels">
  <budgetLockExpiration i:nil="true" />
  <endDate i:nil="true" />
  <id>111</id>
  <name>My campaign</name>
  <partnerSKUs i:nil="true" />
  <status>Active</status>
  <subscription>
    <active>true</active>
    <billingType>Automatic</billingType>
    <budget>1500</budget>
    <currency>USD</currency>
    <nextCharge>2025-07-30T02:49:26.5580935+00:00</nextCharge>
    <type>SearchCampaign</type>
  </subscription>
  <subscriptionExpiration>2025-07-30T02:49:26.5580935+00:00</subscriptionExpiration>
  <type>Search</type>
</CampaignSubscription>