Counts the ContractPlans that match a filter.

POST /api/contract-plans/list/continuation/count deprecated

Requires: Customers.ContractPlans, merchant scope.

Takes the same request body as the continuation list endpoint and returns how many ContractPlans match it, without returning the records themselves. The count is approximate and is intended to sit alongside a paged list, so treat it as a display figure rather than a reconciliation total.

Try this in the console

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a GetContractPlanContinuationInput. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/contract-plans/list/continuation/count" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isActive": false,
  "filter": {},
  "maxResultCount": 0,
  "continuationToken": "",
  "sorting": {},
  "maxCreationTime": "2026-01-01T00:00:00Z",
  "minCreationTime": "2026-01-01T00:00:00Z",
  "maxModificationTime": "2026-01-01T00:00:00Z",
  "maxModifitionTime": "2026-01-01T00:00:00Z",
  "minModificationTime": "2026-01-01T00:00:00Z",
  "minModifitionTime": "2026-01-01T00:00:00Z",
  "includeDeleted": false,
  "includeInactive": false,
  "includeApproxTotalCount": false
}'

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isActive": false,
  "filter": {},
  "maxResultCount": 0,
  "continuationToken": "",
  "sorting": {},
  "maxCreationTime": "2026-01-01T00:00:00Z",
  "minCreationTime": "2026-01-01T00:00:00Z",
  "maxModificationTime": "2026-01-01T00:00:00Z",
  "maxModifitionTime": "2026-01-01T00:00:00Z",
  "minModificationTime": "2026-01-01T00:00:00Z",
  "minModifitionTime": "2026-01-01T00:00:00Z",
  "includeDeleted": false,
  "includeInactive": false,
  "includeApproxTotalCount": false
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/contract-plans/list/continuation/count' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, ContractPlansApi } from '@winkpg/winkpg-api';

const api = new ContractPlansApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.contractPlansGetApproximateTotalCount({
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isActive": false,
  "filter": {},
  "maxResultCount": 0,
  "continuationToken": "",
  "sorting": {},
  "maxCreationTime": "2026-01-01T00:00:00Z",
  "minCreationTime": "2026-01-01T00:00:00Z",
  "maxModificationTime": "2026-01-01T00:00:00Z",
  "maxModifitionTime": "2026-01-01T00:00:00Z",
  "minModificationTime": "2026-01-01T00:00:00Z",
  "minModifitionTime": "2026-01-01T00:00:00Z",
  "includeDeleted": false,
  "includeInactive": false,
  "includeApproxTotalCount": false
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/contract-plans/list/continuation/count', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "isActive": false,
    "filter": {},
    "maxResultCount": 0,
    "continuationToken": "",
    "sorting": {},
    "maxCreationTime": "2026-01-01T00:00:00Z",
    "minCreationTime": "2026-01-01T00:00:00Z",
    "maxModificationTime": "2026-01-01T00:00:00Z",
    "maxModifitionTime": "2026-01-01T00:00:00Z",
    "minModificationTime": "2026-01-01T00:00:00Z",
    "minModifitionTime": "2026-01-01T00:00:00Z",
    "includeDeleted": false,
    "includeInactive": false,
    "includeApproxTotalCount": false
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new ContractPlansApi(config);
var body = JsonSerializer.Deserialize<GetContractPlanContinuationInput>("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "isActive": false,
      "filter": {},
      "maxResultCount": 0,
      "continuationToken": "",
      "sorting": {},
      "maxCreationTime": "2026-01-01T00:00:00Z",
      "minCreationTime": "2026-01-01T00:00:00Z",
      "maxModificationTime": "2026-01-01T00:00:00Z",
      "maxModifitionTime": "2026-01-01T00:00:00Z",
      "minModificationTime": "2026-01-01T00:00:00Z",
      "minModifitionTime": "2026-01-01T00:00:00Z",
      "includeDeleted": false,
      "includeInactive": false,
      "includeApproxTotalCount": false
    }
    """);

var result = await api.ContractPlansGetApproximateTotalCountAsync(body);

C# (raw HTTP)

using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/contract-plans/list/continuation/count");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "isActive": false,
      "filter": {},
      "maxResultCount": 0,
      "continuationToken": "",
      "sorting": {},
      "maxCreationTime": "2026-01-01T00:00:00Z",
      "minCreationTime": "2026-01-01T00:00:00Z",
      "maxModificationTime": "2026-01-01T00:00:00Z",
      "maxModifitionTime": "2026-01-01T00:00:00Z",
      "minModificationTime": "2026-01-01T00:00:00Z",
      "minModifitionTime": "2026-01-01T00:00:00Z",
      "includeDeleted": false,
      "includeInactive": false,
      "includeApproxTotalCount": false
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.ContractPlansApi(client)
    body = winkpg_api.GetContractPlanContinuationInput.from_dict({
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "isActive": False,
      "filter": {},
      "maxResultCount": 0,
      "continuationToken": "",
      "sorting": {},
      "maxCreationTime": "2026-01-01T00:00:00Z",
      "minCreationTime": "2026-01-01T00:00:00Z",
      "maxModificationTime": "2026-01-01T00:00:00Z",
      "maxModifitionTime": "2026-01-01T00:00:00Z",
      "minModificationTime": "2026-01-01T00:00:00Z",
      "minModifitionTime": "2026-01-01T00:00:00Z",
      "includeDeleted": False,
      "includeInactive": False,
      "includeApproxTotalCount": False
    })
    result = api.contract_plans_get_approximate_total_count(body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isActive": False,
  "filter": {},
  "maxResultCount": 0,
  "continuationToken": "",
  "sorting": {},
  "maxCreationTime": "2026-01-01T00:00:00Z",
  "minCreationTime": "2026-01-01T00:00:00Z",
  "maxModificationTime": "2026-01-01T00:00:00Z",
  "maxModifitionTime": "2026-01-01T00:00:00Z",
  "minModificationTime": "2026-01-01T00:00:00Z",
  "minModifitionTime": "2026-01-01T00:00:00Z",
  "includeDeleted": False,
  "includeInactive": False,
  "includeApproxTotalCount": False
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/contract-plans/list/continuation/count",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`merchantId` required	string (uuid)	Scope to one merchant's catalog. nullable
`isActive` required	boolean	Scope to active or inactive plans. nullable
`filter` required	all of FilterGroup	The grid's composed chip, search, and summary filters.
`maxResultCount` required	integer (int32)	Page size.
`continuationToken` required	string	Continuation token for the next page, as returned by the previous page. nullable
`sorting` required	all of SortDescriptor	Sort field and direction.
`maxCreationTime` required	string (date-time)	Upper bound on creation time. nullable
`minCreationTime` required	string (date-time)	Lower bound on creation time. nullable
`maxModificationTime` required	string (date-time)	Upper bound on last modification time. nullable
`maxModifitionTime` required	string (date-time)	Deprecated misspelled alias of `maxModificationTime`. nullabledeprecated
`minModificationTime` required	string (date-time)	Lower bound on last modification time. nullable
`minModifitionTime` required	string (date-time)	Deprecated misspelled alias of `minModificationTime`. nullabledeprecated
`includeDeleted` required	boolean	Include soft-deleted plans, so a deleted plan can be restored from the grid.
`includeInactive` required	boolean	Include plans the platform marks inactive.
`includeApproxTotalCount` required	boolean	Set to false to skip the approximate total count query and receive a null count; omit the value or set it to true to receive the count as before. nullable

This request body has no documented fields.