Suggests promotion codes built from the values the caller has filled in so far.

POST /api/promotions/suggest-codes deprecated

Requires: Promotions.Promotions, merchant scope.

Requires API key scope: transactions:write (Take payments)

Memorable codes are guessable by design: they are marketing codes a customer reads off a flyer. Ask for the private style for a single-use or goodwill discount. Nothing is stored; a suggestion becomes a promotion only when it is created.

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 SuggestPromotionCodesInput. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/promotions/suggest-codes" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "excludePromotionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "style": {},
  "count": 1,
  "discountType": {},
  "value": 0,
  "currency": "",
  "name": "",
  "startsAtUtc": "2026-01-01T00:00:00Z",
  "appliesToScope": {},
  "durationMode": {},
  "durationCycles": 0
}'

PowerShell

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

$body = @'
{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "excludePromotionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "style": {},
  "count": 1,
  "discountType": {},
  "value": 0,
  "currency": "",
  "name": "",
  "startsAtUtc": "2026-01-01T00:00:00Z",
  "appliesToScope": {},
  "durationMode": {},
  "durationCycles": 0
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/promotions/suggest-codes' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, PromotionsApi } from '@winkpg/winkpg-api';

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

const { data } = await api.promotionsSuggestCodes({
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "excludePromotionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "style": {},
  "count": 1,
  "discountType": {},
  "value": 0,
  "currency": "",
  "name": "",
  "startsAtUtc": "2026-01-01T00:00:00Z",
  "appliesToScope": {},
  "durationMode": {},
  "durationCycles": 0
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/promotions/suggest-codes', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "excludePromotionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "style": {},
    "count": 1,
    "discountType": {},
    "value": 0,
    "currency": "",
    "name": "",
    "startsAtUtc": "2026-01-01T00:00:00Z",
    "appliesToScope": {},
    "durationMode": {},
    "durationCycles": 0
  }),
});

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 PromotionsApi(config);
var body = JsonSerializer.Deserialize<SuggestPromotionCodesInput>("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "excludePromotionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "style": {},
      "count": 1,
      "discountType": {},
      "value": 0,
      "currency": "",
      "name": "",
      "startsAtUtc": "2026-01-01T00:00:00Z",
      "appliesToScope": {},
      "durationMode": {},
      "durationCycles": 0
    }
    """);

var result = await api.PromotionsSuggestCodesAsync(body);

C# (raw HTTP)

using System.Text;

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

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/promotions/suggest-codes");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "excludePromotionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "style": {},
      "count": 1,
      "discountType": {},
      "value": 0,
      "currency": "",
      "name": "",
      "startsAtUtc": "2026-01-01T00:00:00Z",
      "appliesToScope": {},
      "durationMode": {},
      "durationCycles": 0
    }
    """, 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.PromotionsApi(client)
    body = winkpg_api.SuggestPromotionCodesInput.from_dict({
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "excludePromotionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "style": {},
      "count": 1,
      "discountType": {},
      "value": 0,
      "currency": "",
      "name": "",
      "startsAtUtc": "2026-01-01T00:00:00Z",
      "appliesToScope": {},
      "durationMode": {},
      "durationCycles": 0
    })
    result = api.promotions_suggest_codes(body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "excludePromotionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "style": {},
  "count": 1,
  "discountType": {},
  "value": 0,
  "currency": "",
  "name": "",
  "startsAtUtc": "2026-01-01T00:00:00Z",
  "appliesToScope": {},
  "durationMode": {},
  "durationCycles": 0
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/promotions/suggest-codes",
    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.

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.

Request body

application/json , required

Field Type Description

merchantId required

string (uuid)

The merchant the promotion will belong to. When given, codes the merchant already uses are left out of the suggestions. The caller must be authorized over the merchant. Conditional: When MerchantId is not null. 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.

excludePromotionId required

string (uuid)

The promotion being edited, so its own current code is not treated as taken. 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.

style required

PromotionCodeSuggestionStyle PromotionCodeSuggestionStyle

Memorable marketing codes, or private single-use ones.

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.

`Memorable`	A marketing code a customer can read off a flyer and type at checkout, built from the promotion's own value, name, start date and scope, for example WELCOME10. Guessable by design.
`Private`	A code for a single customer or a goodwill discount: a word, a hyphen and four characters drawn from a cryptographic random source, for example THANKS-K7Q2. Nothing in it comes from the promotion's own details, so it cannot be inferred from a flyer or a name. It is still a short bearer value: give the promotion a redemption limit rather than relying on the suffix to keep it private.

count required

integer (int32)

How many suggestions to return, between 1 and `MaxCount`. min 1max 10

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.

discountType required

PromotionDiscountType PromotionDiscountType

Whether the value is a percentage or a flat amount. 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.

`Percent`	A percentage of the amount, for example 10 meaning 10%.
`Flat`	A flat amount in the promotion's currency, for example 5 meaning 5.00.

value required

number (double)

The percentage, or the flat amount. 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.

currency required

string

The ISO 4217 currency, when the promotion has one. 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.

name required

string

The operator-facing promotion name. Its first word may appear in a suggestion. nullablemax length 128

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.

startsAtUtc required

string (date-time)

When the promotion starts. The season and month in a suggestion are read from it. 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.

appliesToScope required

PromotionAppliesToScope PromotionAppliesToScope

What the promotion applies to. 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.

`Any`	Anything the merchant charges for. No target list is consulted.
`HostedPages`	Only the named hosted payment pages.
`Products`	Only the named products.
`Plans`	Only the named contract plans.

durationMode required

PromotionDurationMode PromotionDurationMode

How long the discount runs on a recurring charge. 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.

`FirstBillOnly`	Discount only the first bill.
`Cycles`	Discount a fixed number of billing cycles.
`UntilRemoved`	Discount every bill until someone takes the promotion off the subscription.

durationCycles required

integer (int32)

How many billing cycles the discount runs for. 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 request body has no documented fields.

Responses

200 OK

Body: ListResultDtoOfPromotionCodeSuggestionDto ListResultDtoOfPromotionCodeSuggestionDto Each item has these fields.

Field Type Description

items required

array of PromotionCodeSuggestionDto array of PromotionCodeSuggestionDto

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.

Fields of each PromotionCodeSuggestionDto:

Field Type Description

code required

string

The code, in its stored form: trimmed and upper-cased. 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 body has no documented fields.

This response has no documented body fields.

403 Forbidden

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

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

401 Unauthorized

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

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

400 Bad Request

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

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

404 Not Found

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

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

501 Not Implemented

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

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

500 Internal Server Error

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

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

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 lists the values `error.code` can take. 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 lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

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

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.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

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

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by Promotions

The API reference isn't available right now

No such operation

This reference may be out of date

Suggests promotion codes built from the values the caller has filled in so far.

Example request

Parameters

Request body

Responses

200 OK

403 Forbidden

401 Unauthorized

400 Bad Request

404 Not Found

501 Not Implemented

500 Internal Server Error

Errors

Authentication