Lists the active plans the caller may subscribe a contract to, with today's price on each.

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

cURL PowerShell TypeScript C# Python

cURL

curl -X GET "{{BASE_URL}}/api/contract-plans/lookup" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/contract-plans/lookup' `
    -Headers $headers

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.contractPlansGetLookupList();

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/contract-plans/lookup', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

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

var api = new ContractPlansApi(config);
var result = await api.ContractPlansGetLookupListAsync();

C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/contract-plans/lookup");
request.Headers.Add("api-key", "{{API_KEY}}");

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)
    result = api.contract_plans_get_lookup_list()

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/contract-plans/lookup",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description

merchantId required

query

string (uuid)

Narrow the result to one merchant's catalog. Omit it to list every plan in the caller's own merchant scope.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

includePlanId required

query

string (uuid)

One additional plan to include even if it is no longer active, when it is visible to the caller and inside `merchantId`. This is how an editor for a contract already subscribed to a retired plan still shows what that contract is on: an inactive plan takes no new subscriptions but keeps pricing its existing ones, so a caller that could not see it would have no way to tell a retired subscription apart from an unreachable one.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

suppressNulls required

query

boolean

If true, omit properties with null values.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.

Responses

200 OK

OK

Body: array of ContractPlanLookupDto array of ContractPlanLookupDto Each item has these fields.

Field Type Description

id required

string (uuid)

The plan's identifier, which is what a contract stores.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

merchantId required

string (uuid)

The merchant that owns the plan.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

name required

string

The plan's operator-facing name. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

code required

string

The merchant's own short code for the plan, or null. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

currencyCode required

string

The ISO 4217 alphabetic currency code the plan's amounts are denominated in. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isActive required

boolean

Whether the plan is still open to new subscriptions. Normally true: the picker lists active plans. It is false only for a plan pulled in by `includePlanId`, which is how a contract already subscribed to a retired plan keeps showing what it is on.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isDeleted required

boolean

Whether the plan has been deleted. Only ever true for a plan pulled in by `includePlanId`. A deleted plan cannot price anything: the billing engine refuses to charge a contract it cannot read a plan for, and that refusal is the point of deleting one. It is carried here so the contract that is still pointing at it says so, instead of the picker quietly showing no plan at all.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

currentTotalAmount required

number (double)

What a subscriber is charged per cycle today: the revision in force at the moment the picker was loaded. A plan carrying a scheduled change still shows today's price here, because that is what a contract created now would first bill.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

trialDays required

integer (int32)

The trial length a new contract on this plan inherits, in days, or null when the plan offers no trial. The contract form seeds its trial end date from it when the plan is picked. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

defaultSchedule required

ContractSchedule ContractSchedule

The recurrence a new contract on this plan starts from, or null when the plan suggests none. A suggestion only: the contract owns its schedule once created, and changing the plan's never moves an existing subscriber.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of ContractSchedule:

Field Type Description

frequency required

Frequency Frequency

The type of the recurrence rule.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Secondly`
`Minutely`
`Hourly`
`Daily`
`Weekly`
`Monthly`
`Yearly`

count required

integer (int32)

The number of occurrences in a particular recurrence. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

until required

string (date-time)

The datetime that bounds the current recurrence. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

interval required

integer (int32)

The recurrence interval.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

bySecond required

array of integer (int32) array of

BySecond rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

byMinute required

array of integer (int32) array of

BySecond rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

byHour required

array of integer (int32) array of

BySecond rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

byDay required

array of ContractScheduleByDayRule array of ContractScheduleByDayRule

Week day rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

byMonth required

array of integer (int32) array of

Month day rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

byMonthDay required

array of integer (int32) array of

Month days rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

byYearDay required

array of integer (int32) array of

Year days rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

byWeekNumber required

array of integer (int32) array of

Week number rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

bySetPosition required

array of integer (int32) array of

BySetPosition rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

firstDayOfWeek required

DayOfWeek DayOfWeek

The first day of week, used in calculating weekday-based recurrences nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Sunday`
`Monday`
`Tuesday`
`Wednesday`
`Thursday`
`Friday`
`Saturday`

nextScheduledRun required

string (date-time)

The next computed billing date, updated after each billing run. Null for contracts that have never been scheduled or have ended. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

startDate required

string (date-time)

The earliest date on which this contract is eligible to bill. Set by the user when creating the contract (defaults to the creation date) and may be set to a future date to delay first billing. The recurrence engine anchors expansion to this date and the daily billing job will not fire a contract whose `startDate` is in the future. Null on contracts created before this field existed. When it is null, the server anchors the schedule on the contract's creation time, or on the current time when that is also absent; callers that compute a schedule themselves should apply the same fallback. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

This response has no documented body fields.

429 Too Many Requests

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

Errors 400 401 403 404 500 501 default

400 Bad Request Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why.
401 Unauthorized Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired.
403 Forbidden Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason.
404 Not Found Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found.
500 Internal Server Error Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`.
501 Not Implemented Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of RemoteServiceErrorInfo:

Field Type Description

code required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

message required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

details required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

data required

object

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

validationErrors required

array of RemoteServiceValidationErrorInfo array of RemoteServiceValidationErrorInfo

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by

Authentication

ApiKey with scopes

The API reference isn't available right now

No such operation

This reference may be out of date

Lists the active plans the caller may subscribe a contract to, with today's price on each.

Example request

Parameters

Request body

Responses

Errors

Authentication