# GET /api/contract-plans/lookup Lists the active plans the caller may subscribe a contract to, with today's price on each. **Required permissions**: `Customers.ContractPlans` **Scope**: merchant **Operation ID:** `contractPlansGetLookupList` ## Authorization Requires: Customers.ContractPlans, merchant scope. Requires API key scope: `admin` Required permissions: - `Customers.ContractPlans` ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | merchantId | query | no | string(uuid) | Narrow the result to one merchant's catalog. Omit it to list every plan in the caller's own merchant scope. | | includePlanId | query | no | 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. | | suppressNulls | query | no | boolean | If true, omit properties with null values. | ## Responses ### 200 OK **Content type:** `application/json` Schema type: `array<[ContractPlanLookupDto](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ContractPlanLookupDto.md)>` Item properties: - `id` (string(uuid)): The plan's identifier, which is what a contract stores. - `merchantId` (string(uuid)): The merchant that owns the plan. - `name` (string): The plan's operator-facing name. (nullable) - `code` (string): The merchant's own short code for the plan, or null. (nullable) - `currencyCode` (string): The ISO 4217 alphabetic currency code the plan's amounts are denominated in. (nullable) - `isActive` (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. - `isDeleted` (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. - `currentTotalAmount` (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. - `trialDays` (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) - `defaultSchedule` ([ContractSchedule](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ContractSchedule.md)): 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. Fields: - `frequency` ([Frequency](https://devportal.signapay-sbx.winkpg.io/docs/api/models/Frequency.md)): The type of the recurrence rule. Values: - `Secondly` - `Minutely` - `Hourly` - `Daily` - `Weekly` - `Monthly` - `Yearly` - `count` (integer(int32)): The number of occurrences in a particular recurrence. (nullable) - `until` (string(date-time)): The datetime that bounds the current recurrence. (nullable) - `interval` (integer(int32)): The recurrence interval. - `bySecond` (array): BySecond rule modifier. (nullable) - `byMinute` (array): BySecond rule modifier. (nullable) - `byHour` (array): BySecond rule modifier. (nullable) - `byDay` (array<[ContractScheduleByDayRule](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ContractScheduleByDayRule.md)>): Week day rule modifier. (nullable) - `byMonth` (array): Month day rule modifier. (nullable) - `byMonthDay` (array): Month days rule modifier. (nullable) - `byYearDay` (array): Year days rule modifier. (nullable) - `byWeekNumber` (array): Week number rule modifier. (nullable) - `bySetPosition` (array): BySetPosition rule modifier. (nullable) - `firstDayOfWeek` ([DayOfWeek](https://devportal.signapay-sbx.winkpg.io/docs/api/models/DayOfWeek.md)): The first day of week, used in calculating weekday-based recurrences (nullable) Values: - `Sunday` - `Monday` - `Tuesday` - `Wednesday` - `Thursday` - `Friday` - `Saturday` - `nextScheduledRun` (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) - `startDate` (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) ### 429 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. **Content type:** `application/problem+json` Schema: [`RateLimitProblemDetails`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RateLimitProblemDetails.md) Properties: - `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself, so there is no sub-type for a caller to branch on. (nullable) - `title` (string) required: A short, human-readable summary of the problem type. (nullable) - `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines. - `detail` (string) required: A human-readable explanation of this occurrence of the problem. (nullable) - `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the `Retry-After` header. Always at least one: a value of zero would invite an immediate retry that is certain to be rejected again. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 400 Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Request failed validation_ One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing. ```json { "error": { "code": null, "message": "Your request is not valid!", "details": "The following errors were detected during validation.", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": [ { "message": "'Amount' must be greater than 0.", "members": [ "amount" ] }, { "message": "The card has expired.", "members": [ "expirationDate" ], "code": "CardData:CardExpired" }, { "message": "'Value' must not be empty.", "members": [ "value" ], "memberPaths": [ "customFields[2].value" ] } ] } } ``` ### 401 Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 403 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. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 404 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. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Resource not found_ The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message. ```json { "error": { "code": null, "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!", "details": null, "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": null } } ``` ### 500 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`. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 501 Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 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](https://devportal.signapay-sbx.winkpg.io/docs/errors.md) lists the values `error.code` can take. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Business rule refused the request_ The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code. ```json { "error": { "code": "Transactions:OperationNotAllowed", "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.", "details": null, "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": null } } ``` ### Errors These statuses answer with the error envelope outlined below. - `400`: Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why. - `401`: Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired. - `403`: 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. 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. 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. 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](https://devportal.signapay-sbx.winkpg.io/docs/errors.md) lists the values `error.code` can take. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) Fields: - `code` (string): (nullable) - `message` (string): (nullable) - `details` (string): (nullable) - `data` (object): (nullable) - `validationErrors` (array<[RemoteServiceValidationErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceValidationErrorInfo.md)>): (nullable) _Example: Request failed validation_ One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing. ```json { "error": { "code": null, "message": "Your request is not valid!", "details": "The following errors were detected during validation.", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": [ { "message": "'Amount' must be greater than 0.", "members": [ "amount" ] }, { "message": "The card has expired.", "members": [ "expirationDate" ], "code": "CardData:CardExpired" }, { "message": "'Value' must not be empty.", "members": [ "value" ], "memberPaths": [ "customFields[2].value" ] } ] } } ``` ## Authentication - `ApiKey` ## 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. ### cURL ```bash curl -X GET "{{BASE_URL}}/api/contract-plans/lookup" \ -H "api-key: {{API_KEY}}" ``` ### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/contract-plans/lookup' ` -Headers $headers ``` ### TypeScript (SDK) ```bash npm install @winkpg/winkpg-api ``` ```typescript 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) ```typescript const response = await fetch('{{BASE_URL}}/api/contract-plans/lookup', { method: 'GET', headers: { "api-key": "{{API_KEY}}", }, }); const data = await response.json(); ``` ### C# (SDK) ```bash dotnet add package WinkPg.Api.Client ``` ```csharp 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) ```csharp 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(); ``` ### Python (SDK) ```bash pip install winkpg-api ``` ```python 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() ``` ### Python (raw HTTP) ```bash pip install requests ``` ```python 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() ``` ## See also - [All documentation](https://devportal.signapay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.