# 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.

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>`

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.
- `code` (string): The merchant's own short code for the plan, or null.
- `currencyCode` (string): The ISO 4217 alphabetic currency code the plan's amounts are denominated in.
- `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.
- `defaultSchedule` (object): 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.

### 403

Forbidden

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 401

Unauthorized

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 400

Bad Request

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 404

Not Found

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 501

Not Implemented

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 500

Internal Server Error

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 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. See the error-code reference in this document's description for the values `error.code` can take.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 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`

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.
- `title` (string) required: A short, human-readable summary of the problem type.
- `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.
- `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`

Properties:
- `error` (RemoteServiceErrorInfo)

## 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-simpay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.