Records a new price on a plan and states when it starts applying to existing subscribers.

POST /api/contract-plans/{id}/prices deprecated

Requires: Customers.ContractPlans, Customers.ContractPlans.ChangePrice, merchant scope.

**Required permissions**: `Customers.ContractPlans`, `Customers.ContractPlans.ChangePrice` **Scope**: merchant

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 ChangeContractPlanPriceDto. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/contract-plans/{id}/prices" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "billSubtotalAmount": 0,
  "taxAmount": 0,
  "totalAmount": 1,
  "policy": {},
  "effectiveFrom": "2026-01-01T00:00:00Z",
  "note": "",
  "concurrencyStamp": ""
}'

PowerShell

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

$body = @'
{
  "billSubtotalAmount": 0,
  "taxAmount": 0,
  "totalAmount": 1,
  "policy": {},
  "effectiveFrom": "2026-01-01T00:00:00Z",
  "note": "",
  "concurrencyStamp": ""
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/contract-plans/{id}/prices' `
    -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.contractPlansChangePrice("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "billSubtotalAmount": 0,
  "taxAmount": 0,
  "totalAmount": 1,
  "policy": {},
  "effectiveFrom": "2026-01-01T00:00:00Z",
  "note": "",
  "concurrencyStamp": ""
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/contract-plans/{id}/prices', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "billSubtotalAmount": 0,
    "taxAmount": 0,
    "totalAmount": 1,
    "policy": {},
    "effectiveFrom": "2026-01-01T00:00:00Z",
    "note": "",
    "concurrencyStamp": ""
  }),
});

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<ChangeContractPlanPriceDto>("""
    {
      "billSubtotalAmount": 0,
      "taxAmount": 0,
      "totalAmount": 1,
      "policy": {},
      "effectiveFrom": "2026-01-01T00:00:00Z",
      "note": "",
      "concurrencyStamp": ""
    }
    """);

var result = await api.ContractPlansChangePriceAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), 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/{id}/prices");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "billSubtotalAmount": 0,
      "taxAmount": 0,
      "totalAmount": 1,
      "policy": {},
      "effectiveFrom": "2026-01-01T00:00:00Z",
      "note": "",
      "concurrencyStamp": ""
    }
    """, 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.ChangeContractPlanPriceDto.from_dict({
      "billSubtotalAmount": 0,
      "taxAmount": 0,
      "totalAmount": 1,
      "policy": {},
      "effectiveFrom": "2026-01-01T00:00:00Z",
      "note": "",
      "concurrencyStamp": ""
    })
    result = api.contract_plans_change_price("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "billSubtotalAmount": 0,
  "taxAmount": 0,
  "totalAmount": 1,
  "policy": {},
  "effectiveFrom": "2026-01-01T00:00:00Z",
  "note": "",
  "concurrencyStamp": ""
}

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

Parameters

Name	In	Type	Description
`id` required	path	string (uuid)	The plan to re-price.
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`billSubtotalAmount` required	number (double)	The new base amount charged each cycle, before tax. min 0
`taxAmount` required	number (double)	The new tax added to the base amount each cycle. Leave empty for no tax line. nullablemin 0
`totalAmount` required	number (double)	The new total charged to a subscriber each cycle. min 0
`policy` required	all of ContractPlanPriceChangePolicy	When the new price starts applying to existing subscribers.
`effectiveFrom` required	string (date-time)	The moment the new price takes effect, in UTC. Required for `Scheduled` and ignored for the other two policies, which derive their effective moment from when the change is saved. Required: When Policy == Scheduled. nullable
`note` required	string	Why the price is changing, in the operator's own words. Kept with the revision so the reason survives alongside the amount. nullablemax length 512
`concurrencyStamp` required	string	The concurrency stamp read with the plan, so a price change cannot be applied on top of someone else's. nullable

This request body has no documented fields.