WinkPG Docs

View as Markdown

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-23 00:19 UTC.

`GetMerchantsByPlanInput`

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Input for the plan-side assignments query: the merchants whose `BillingAssignment.PricePlanId` equals `pricePlanId` within the plan's reseller and every reseller beneath it. Continuation-token paged. Backs the plan-side Assignments tab.

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.

Fields

Field Type Description

pricePlanId required

string (uuid)

The price plan whose assigned merchants are being listed.

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.

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.

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.

maxResultCount required

integer (int32)

The maximum number of items to return in a single page. min 1max 1000

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.

continuationToken required

string

Continuation token from a previous page; null for the first page. 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.

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

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 model has no documented fields.