# GET /api/merchants/assignable-for-price-plan

Lists the merchants that can be assigned to a price plan.

Active merchants of the plan's reseller and of every reseller beneath it, minus those already
on the plan, filtered to what the caller is authorized to see. Continuation-paged. Requires the merchant read
permission as well as the plan-assign permission.

**Operation ID:** `merchantsGetAssignableMerchants`

## Authorization

Requires: Merchants.Merchants, merchant scope.

Required permissions:
- `Merchants.Merchants`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

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

Schema: `GetMerchantsByPlanInput`

Properties:
- `pricePlanId` (string(uuid)) required: The price plan whose assigned merchants are being listed.
- `resellerId` (string(uuid)) required: The reseller that owns the price plan. Its merchants and those of every reseller beneath it  are scanned. Resolved server-side from the plan on the calling page: never trusted from  arbitrary client input beyond scoping the read, which the caller must be authorized for.
- `maxResultCount` (integer(int32)): The maximum number of items to return in a single page.
- `continuationToken` (string): Continuation token from a previous page; null for the first page.
- `searchTerm` (string): Optional free-text merchant-name filter for the assign-candidate typeahead. Applied  server-side as an indexable `Name Contains` predicate alongside the reseller-subtree  scope; null/blank returns the first page unfiltered. Used by  `GetAssignableMerchantsAsync` only.

**Content type:** `text/json`

Schema: `GetMerchantsByPlanInput`

Properties:
- `pricePlanId` (string(uuid)) required: The price plan whose assigned merchants are being listed.
- `resellerId` (string(uuid)) required: The reseller that owns the price plan. Its merchants and those of every reseller beneath it  are scanned. Resolved server-side from the plan on the calling page: never trusted from  arbitrary client input beyond scoping the read, which the caller must be authorized for.
- `maxResultCount` (integer(int32)): The maximum number of items to return in a single page.
- `continuationToken` (string): Continuation token from a previous page; null for the first page.
- `searchTerm` (string): Optional free-text merchant-name filter for the assign-candidate typeahead. Applied  server-side as an indexable `Name Contains` predicate alongside the reseller-subtree  scope; null/blank returns the first page unfiltered. Used by  `GetAssignableMerchantsAsync` only.

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

Schema: `GetMerchantsByPlanInput`

Properties:
- `pricePlanId` (string(uuid)) required: The price plan whose assigned merchants are being listed.
- `resellerId` (string(uuid)) required: The reseller that owns the price plan. Its merchants and those of every reseller beneath it  are scanned. Resolved server-side from the plan on the calling page: never trusted from  arbitrary client input beyond scoping the read, which the caller must be authorized for.
- `maxResultCount` (integer(int32)): The maximum number of items to return in a single page.
- `continuationToken` (string): Continuation token from a previous page; null for the first page.
- `searchTerm` (string): Optional free-text merchant-name filter for the assign-candidate typeahead. Applied  server-side as an indexable `Name Contains` predicate alongside the reseller-subtree  scope; null/blank returns the first page unfiltered. Used by  `GetAssignableMerchantsAsync` only.

## Responses

### 200

OK

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

Schema: `ContinuationPagedResultDtoOfMerchantDto`

Properties:
- `items` (array<MerchantDto>): The items returned for this page.
- `nextContinuationToken` (string): Continuation token to use when requesting the next page.  Null means no additional pages exist.
- `approxTotalCount` (integer(int64)): An approximate total count of matching items.  This value is optional and may be stale or estimated, so treat it as an approximation.
- `pageItemCount` (integer(int32)): Convenience property for the number of items in this page.
- `retrievedAt` (string(date-time)): When the page was retrieved. Useful for diagnostics and cache behavior.

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

The request body is a GetMerchantsByPlanInput. See the Request body section below for its fields.

### cURL

```bash
curl -X GET "{{BASE_URL}}/api/merchants/assignable-for-price-plan" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "pricePlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'
```

### PowerShell

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

$body = @'
{
  "pricePlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
'@

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/merchants/assignable-for-price-plan' `
    -Headers $headers -ContentType 'application/json' -Body $body
```

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
import { Configuration, MerchantsApi } from '@winkpg/winkpg-api';

const api = new MerchantsApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.merchantsGetAssignableMerchants({
  "pricePlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/merchants/assignable-for-price-plan', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "pricePlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }),
});

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;
using System.Text.Json;

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

var api = new MerchantsApi(config);
var body = JsonSerializer.Deserialize<GetMerchantsByPlanInput>("""
    {
      "pricePlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    """);

var result = await api.MerchantsGetAssignableMerchantsAsync(body);
```

### C# (raw HTTP)

```csharp
using System.Text;

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

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/merchants/assignable-for-price-plan");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "pricePlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    """, Encoding.UTF8, "application/json");

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.MerchantsApi(client)
    body = winkpg_api.GetMerchantsByPlanInput.from_dict({
      "pricePlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    })
    result = api.merchants_get_assignable_merchants(body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

body = {
  "pricePlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/merchants/assignable-for-price-plan",
    headers=headers,
    json=body,
)
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.