Create a ContractPlan

POST /api/contract-plans deprecated

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

Create a new ContractPlan

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

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/contract-plans" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "",
  "currencyCode": ""
}'

PowerShell

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

$body = @'
{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "",
  "currencyCode": ""
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/contract-plans' `
    -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.contractPlansCreate({
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "",
  "currencyCode": ""
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/contract-plans', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "",
    "currencyCode": ""
  }),
});

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<ContractPlanCreateDto>("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "",
      "currencyCode": ""
    }
    """);

var result = await api.ContractPlansCreateAsync(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");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "",
      "currencyCode": ""
    }
    """, 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.ContractPlanCreateDto.from_dict({
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "",
      "currencyCode": ""
    })
    result = api.contract_plans_create(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",
  "name": "",
  "currencyCode": ""
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/contract-plans",
    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)	The merchant that owns the plan. nullable
`name` required	string	The plan's operator-facing name. Must be unique within the owning merchant. nullablemax length 128
`code` required	string	The merchant's own short code for the plan. Optional, and not resolved by the platform. nullablemax length 64
`description` required	string	What the plan covers, in the operator's own words. nullablemax length 1024
`currencyCode` required	string	The ISO 4217 alphabetic currency code the plan's amounts are denominated in. nullablemin length 3max length 3pattern ^[A-Za-z]{3}$
`isActive` required	boolean	Whether the plan may be subscribed to. Turning it off hides it from the plan picker and blocks new subscriptions; it does not stop billing the contracts already on it.
`defaultSchedule` required	all of ContractSchedule	The recurrence a new contract on this plan starts from. Optional, and a suggestion only: the contract owns its schedule once created.
`trialDays` required	integer (int32)	The trial length a new contract on this plan inherits, in days. Optional; empty or zero means no trial. A default for contract creation only: each contract owns its own trial end date once created, and changing this never moves an existing subscriber. nullablemin 0max 365
`billSubtotalAmount` required	number (double)	The base amount the plan charges each cycle, before tax. min 0
`taxAmount` required	number (double)	The tax added to the base amount each cycle. Leave empty when the plan carries no tax line. nullablemin 0
`totalAmount` required	number (double)	The total charged to a subscriber each cycle. This is the amount the billing engine charges; the subtotal and tax are the operator's breakdown of it. min 0

This request body has no documented fields.