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

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

Requires: Merchants.Merchants, merchant scope.

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.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

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 PowerShell TypeScript C# Python

cURL

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

$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

npm install @winkpg/winkpg-api

TypeScript (SDK)

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)

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

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

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

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

pip install requests

Python (raw HTTP)

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()

Parameters

Name	In	Type	Description
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`pricePlanId` required	string (uuid)	The price plan whose assigned merchants are being listed.
`resellerId` required	string (uuid)	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` required	integer (int32)	The maximum number of items to return in a single page. min 1max 1000
`continuationToken` required	string	Continuation token from a previous page; null for the first page. nullable
`searchTerm` required	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. nullable

This request body has no documented fields.