POST v1/Subscribers/{id}/PreviewBulkPriceChange

Documentation for 'PreviewBulkPriceChange'.

Request Information

Parameters

NameDescriptionAdditional information
id 
Documentation for 'id'.

Define this parameter in the request URI.
import 
Documentation for 'import'.

Define this parameter in the request body.
queryOptions 
Documentation for 'queryOptions'.

Define this parameter in the request URI.

Request body formats

application/json, text/json

Sample:
Click to beautify! 
{
  "filterOptions": {
    "customerCreatedDateRangeStartDate": "2024-05-03T10:56:06.2979491+00:00",
    "customerCreatedDateRangeEndDate": "2024-05-03T10:56:06.2979491+00:00",
    "subscriptionCreatedDateRangeStartDate": "2024-05-03T10:56:06.2979491+00:00",
    "subscriptionCreatedDateRangeEndDate": "2024-05-03T10:56:06.2979491+00:00",
    "nextBillingDateRangeStartDate": "2024-05-03T10:56:06.2979491+00:00",
    "nextBillingDateRangeEndDate": "2024-05-03T10:56:06.2979491+00:00",
    "customerStatuses": "sample string 1",
    "subscriptionStatuses": "sample string 2",
    "intervals": "sample string 3",
    "excludedProducts": "sample string 4",
    "code1": "sample string 5",
    "code2": "sample string 6",
    "code3": "sample string 7",
    "code4": "sample string 8",
    "code5": "sample string 9"
  },
  "selectAll": true,
  "subscriptionIds": [
    1,
    2,
    3
  ],
  "planProductIds": [
    1,
    2,
    3
  ]
}

application/xml, text/xml

Sample:
Click to beautify! 
<SubscriptionProductBulkChange xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Post">
  <FilterOptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/Common.Dto.Get">
    <d2p1:Code1>sample string 5</d2p1:Code1>
    <d2p1:Code2>sample string 6</d2p1:Code2>
    <d2p1:Code3>sample string 7</d2p1:Code3>
    <d2p1:Code4>sample string 8</d2p1:Code4>
    <d2p1:Code5>sample string 9</d2p1:Code5>
    <d2p1:CustomerCreatedDateRangeEndDate>2024-05-03T10:56:06.2979491+00:00</d2p1:CustomerCreatedDateRangeEndDate>
    <d2p1:CustomerCreatedDateRangeStartDate>2024-05-03T10:56:06.2979491+00:00</d2p1:CustomerCreatedDateRangeStartDate>
    <d2p1:CustomerStatuses>sample string 1</d2p1:CustomerStatuses>
    <d2p1:ExcludedProducts>sample string 4</d2p1:ExcludedProducts>
    <d2p1:Intervals>sample string 3</d2p1:Intervals>
    <d2p1:NextBillingDateRangeEndDate>2024-05-03T10:56:06.2979491+00:00</d2p1:NextBillingDateRangeEndDate>
    <d2p1:NextBillingDateRangeStartDate>2024-05-03T10:56:06.2979491+00:00</d2p1:NextBillingDateRangeStartDate>
    <d2p1:SubscriptionCreatedDateRangeEndDate>2024-05-03T10:56:06.2979491+00:00</d2p1:SubscriptionCreatedDateRangeEndDate>
    <d2p1:SubscriptionCreatedDateRangeStartDate>2024-05-03T10:56:06.2979491+00:00</d2p1:SubscriptionCreatedDateRangeStartDate>
    <d2p1:SubscriptionStatuses>sample string 2</d2p1:SubscriptionStatuses>
  </FilterOptions>
  <PlanProductIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
    <d2p1:long>3</d2p1:long>
  </PlanProductIds>
  <SelectAll>true</SelectAll>
  <SubscriptionIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
    <d2p1:long>3</d2p1:long>
  </SubscriptionIds>
</SubscriptionProductBulkChange>

application/x-www-form-urlencoded

Sample:
Click to beautify!

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:
Click to beautify! 
[
  {
    "planProductName": "sample string 1",
    "planProductId": 2,
    "countAttempted": 3,
    "countValid": 4
  },
  {
    "planProductName": "sample string 1",
    "planProductId": 2,
    "countAttempted": 3,
    "countValid": 4
  },
  {
    "planProductName": "sample string 1",
    "planProductId": 2,
    "countAttempted": 3,
    "countValid": 4
  }
]

application/xml, text/xml

Sample:
Click to beautify! 
<ArrayOfSubscriptionProductImportPreview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Get">
  <SubscriptionProductImportPreview>
    <CountAttempted>3</CountAttempted>
    <CountValid>4</CountValid>
    <PlanProductId>2</PlanProductId>
    <PlanProductName>sample string 1</PlanProductName>
  </SubscriptionProductImportPreview>
  <SubscriptionProductImportPreview>
    <CountAttempted>3</CountAttempted>
    <CountValid>4</CountValid>
    <PlanProductId>2</PlanProductId>
    <PlanProductName>sample string 1</PlanProductName>
  </SubscriptionProductImportPreview>
  <SubscriptionProductImportPreview>
    <CountAttempted>3</CountAttempted>
    <CountValid>4</CountValid>
    <PlanProductId>2</PlanProductId>
    <PlanProductName>sample string 1</PlanProductName>
  </SubscriptionProductImportPreview>
</ArrayOfSubscriptionProductImportPreview>