# POST /api/promotions Create a Promotion Create a new Promotion **Operation ID:** `promotionsCreate` ## Authorization Requires: Promotions.Promotions, Promotions.Promotions.Create, merchant scope. Required permissions: - `Promotions.Promotions` - `Promotions.Promotions.Create` ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | suppressNulls | query | no | boolean | If true, omit properties with null values. | ## Request Body **Content type:** `application/json` Schema: `CreatePromotionDto` Properties: - `merchantId` (string(uuid)) required: The merchant that owns this promotion. Required on create, and immutable afterwards: an update that names a different merchant is refused rather than silently moving the promotion and the ledger entries that point at it. - `code` (string) required: The code a payer types. Stored trimmed and upper-cased, and unique among the merchant's promotions, so `save10` and `SAVE10` are the same code rather than two. Conditional: When Code is not empty. - `name` (string) required: Operator-facing promotion name. Never shown to payers. - `description` (string): Free-text description of the promotion. - `discountType` (object): Whether the value is a percentage or a flat amount. - `value` (number(double)): The percentage, or the flat amount in `currency`. Conditional: When DiscountType == Percent. Must be <= 100. Conditional: When DiscountType == Flat. Must be <= 1000000. - `currency` (string): The ISO 4217 currency. Required for a flat amount, and optional for a percentage, where it narrows the promotion to one currency rather than denominating anything. Required: When DiscountType == Flat. Conditional: When Currency is not empty. Length: 3 to 3. - `startsAtUtc` (string(date-time)): UTC moment the promotion starts being accepted. `null` starts it immediately. - `endsAtUtc` (string(date-time)): UTC moment the promotion stops being accepted. `null` leaves it open. - `maxRedemptions` (integer(int32)): How many times the promotion may be redeemed in total. `null` for no ceiling. Conditional: When MaxRedemptions is not null. Must be > 0. - `maxRedemptionsPerCustomer` (integer(int32)): How many times one customer may redeem it. `null` for no ceiling. A promotion that carries one refuses a redemption that identifies no customer. Conditional: When MaxRedemptionsPerCustomer is not null. Must be > 0. - `minimumSubtotal` (number(double)): The smallest amount the promotion applies to. `null` for no floor. Conditional: When MinimumSubtotal is not null. Must be >= 0. - `appliesToScope` (object): What the promotion may be applied to. - `appliesToTargetIds` (array): The pages, products or plans the scope names. Required by every scope except `Any`, which ignores it. Conditional: When AppliesToScope != Any. Conditional: When AppliesToTargetIds is not null. - `durationMode` (object): How long the discount runs on a recurring charge. - `durationCycles` (integer(int32)): How many billing cycles the discount runs for. Required by `Cycles`, and ignored by every other mode. Required: When DurationMode == Cycles. - `isActive` (boolean): Whether the promotion is accepted. A deactivated promotion keeps its ledger. **Content type:** `text/json` Schema: `CreatePromotionDto` Properties: - `merchantId` (string(uuid)) required: The merchant that owns this promotion. Required on create, and immutable afterwards: an update that names a different merchant is refused rather than silently moving the promotion and the ledger entries that point at it. - `code` (string) required: The code a payer types. Stored trimmed and upper-cased, and unique among the merchant's promotions, so `save10` and `SAVE10` are the same code rather than two. Conditional: When Code is not empty. - `name` (string) required: Operator-facing promotion name. Never shown to payers. - `description` (string): Free-text description of the promotion. - `discountType` (object): Whether the value is a percentage or a flat amount. - `value` (number(double)): The percentage, or the flat amount in `currency`. Conditional: When DiscountType == Percent. Must be <= 100. Conditional: When DiscountType == Flat. Must be <= 1000000. - `currency` (string): The ISO 4217 currency. Required for a flat amount, and optional for a percentage, where it narrows the promotion to one currency rather than denominating anything. Required: When DiscountType == Flat. Conditional: When Currency is not empty. Length: 3 to 3. - `startsAtUtc` (string(date-time)): UTC moment the promotion starts being accepted. `null` starts it immediately. - `endsAtUtc` (string(date-time)): UTC moment the promotion stops being accepted. `null` leaves it open. - `maxRedemptions` (integer(int32)): How many times the promotion may be redeemed in total. `null` for no ceiling. Conditional: When MaxRedemptions is not null. Must be > 0. - `maxRedemptionsPerCustomer` (integer(int32)): How many times one customer may redeem it. `null` for no ceiling. A promotion that carries one refuses a redemption that identifies no customer. Conditional: When MaxRedemptionsPerCustomer is not null. Must be > 0. - `minimumSubtotal` (number(double)): The smallest amount the promotion applies to. `null` for no floor. Conditional: When MinimumSubtotal is not null. Must be >= 0. - `appliesToScope` (object): What the promotion may be applied to. - `appliesToTargetIds` (array): The pages, products or plans the scope names. Required by every scope except `Any`, which ignores it. Conditional: When AppliesToScope != Any. Conditional: When AppliesToTargetIds is not null. - `durationMode` (object): How long the discount runs on a recurring charge. - `durationCycles` (integer(int32)): How many billing cycles the discount runs for. Required by `Cycles`, and ignored by every other mode. Required: When DurationMode == Cycles. - `isActive` (boolean): Whether the promotion is accepted. A deactivated promotion keeps its ledger. **Content type:** `application/*+json` Schema: `CreatePromotionDto` Properties: - `merchantId` (string(uuid)) required: The merchant that owns this promotion. Required on create, and immutable afterwards: an update that names a different merchant is refused rather than silently moving the promotion and the ledger entries that point at it. - `code` (string) required: The code a payer types. Stored trimmed and upper-cased, and unique among the merchant's promotions, so `save10` and `SAVE10` are the same code rather than two. Conditional: When Code is not empty. - `name` (string) required: Operator-facing promotion name. Never shown to payers. - `description` (string): Free-text description of the promotion. - `discountType` (object): Whether the value is a percentage or a flat amount. - `value` (number(double)): The percentage, or the flat amount in `currency`. Conditional: When DiscountType == Percent. Must be <= 100. Conditional: When DiscountType == Flat. Must be <= 1000000. - `currency` (string): The ISO 4217 currency. Required for a flat amount, and optional for a percentage, where it narrows the promotion to one currency rather than denominating anything. Required: When DiscountType == Flat. Conditional: When Currency is not empty. Length: 3 to 3. - `startsAtUtc` (string(date-time)): UTC moment the promotion starts being accepted. `null` starts it immediately. - `endsAtUtc` (string(date-time)): UTC moment the promotion stops being accepted. `null` leaves it open. - `maxRedemptions` (integer(int32)): How many times the promotion may be redeemed in total. `null` for no ceiling. Conditional: When MaxRedemptions is not null. Must be > 0. - `maxRedemptionsPerCustomer` (integer(int32)): How many times one customer may redeem it. `null` for no ceiling. A promotion that carries one refuses a redemption that identifies no customer. Conditional: When MaxRedemptionsPerCustomer is not null. Must be > 0. - `minimumSubtotal` (number(double)): The smallest amount the promotion applies to. `null` for no floor. Conditional: When MinimumSubtotal is not null. Must be >= 0. - `appliesToScope` (object): What the promotion may be applied to. - `appliesToTargetIds` (array): The pages, products or plans the scope names. Required by every scope except `Any`, which ignores it. Conditional: When AppliesToScope != Any. Conditional: When AppliesToTargetIds is not null. - `durationMode` (object): How long the discount runs on a recurring charge. - `durationCycles` (integer(int32)): How many billing cycles the discount runs for. Required by `Cycles`, and ignored by every other mode. Required: When DurationMode == Cycles. - `isActive` (boolean): Whether the promotion is accepted. A deactivated promotion keeps its ledger. ## Responses ### 200 OK **Content type:** `application/json` Schema: `PromotionDto` Properties: - `extraProperties` (object) - `id` (string(uuid)) - `creationTime` (string(date-time)): The date and time when this entity was created. - `creatorId` (string(uuid)): The ID of the user who created this entity. - `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. - `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. - `isDeleted` (boolean): Indicates whether this entity has been deleted. - `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted. - `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted. - `merchantId` (string(uuid)): The merchant that owns this promotion. - `code` (string): The code a payer types, in its stored normalized form. - `name` (string): Operator-facing promotion name. - `description` (string): Free-text description of the promotion. - `discountType` (object): Whether the value is a percentage or a flat amount. - `value` (number(double)): The percentage, or the flat amount in `currency`. - `currency` (string): The ISO 4217 currency, when the promotion is pinned to one. - `startsAtUtc` (string(date-time)): UTC moment the promotion starts being accepted. - `endsAtUtc` (string(date-time)): UTC moment the promotion stops being accepted. - `maxRedemptions` (integer(int32)): How many times the promotion may be redeemed in total. - `maxRedemptionsPerCustomer` (integer(int32)): How many times one customer may redeem it. - `minimumSubtotal` (number(double)): The smallest amount the promotion applies to. - `redemptionCount` (integer(int32)): How many times the promotion has been redeemed. - `remainingRedemptions` (integer(int32)): How many redemptions remain before the total ceiling, or `null` when there is no ceiling. - `appliesToScope` (object): What the promotion may be applied to. - `appliesToTargetIds` (array): The pages, products or plans the scope names. - `durationMode` (object): How long the discount runs on a recurring charge. - `durationCycles` (integer(int32)): How many billing cycles the discount runs for, when the duration counts cycles. - `isActive` (boolean): Whether the promotion is accepted. - `isRedeemable` (boolean): Whether the promotion would be accepted right now: active, inside its window, and with redemptions left. It says nothing about any particular order, which only an evaluation against a real amount and target can answer. - `concurrencyStamp` (string): Optimistic concurrency token. ### 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 CreatePromotionDto. See the Request body section below for its fields. ### cURL ```bash curl -X POST "{{BASE_URL}}/api/promotions" \ -H "api-key: {{API_KEY}}" \ -H "Content-Type: application/json" \ -d '{ "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "code": "", "name": "" }' ``` ### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $body = @' { "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "code": "", "name": "" } '@ $response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/promotions' ` -Headers $headers -ContentType 'application/json' -Body $body ``` ### TypeScript (SDK) ```bash npm install @winkpg/winkpg-api ``` ```typescript import { Configuration, PromotionsApi } from '@winkpg/winkpg-api'; const api = new PromotionsApi(new Configuration({ basePath: '{{BASE_URL}}', apiKey: '{{API_KEY}}', })); const { data } = await api.promotionsCreate({ "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "code": "", "name": "" }); ``` ### TypeScript (raw HTTP) ```typescript const response = await fetch('{{BASE_URL}}/api/promotions', { method: 'POST', headers: { "api-key": "{{API_KEY}}", "Content-Type": "application/json", }, body: JSON.stringify({ "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "code": "", "name": "" }), }); 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 PromotionsApi(config); var body = JsonSerializer.Deserialize(""" { "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "code": "", "name": "" } """); var result = await api.PromotionsCreateAsync(body); ``` ### C# (raw HTTP) ```csharp using System.Text; using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") }; var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/promotions"); request.Headers.Add("api-key", "{{API_KEY}}"); request.Content = new StringContent(""" { "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "code": "", "name": "" } """, 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.PromotionsApi(client) body = winkpg_api.CreatePromotionDto.from_dict({ "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "code": "", "name": "" }) result = api.promotions_create(body) ``` ### Python (raw HTTP) ```bash pip install requests ``` ```python import requests headers = { "api-key": "{{API_KEY}}", "Content-Type": "application/json", } body = { "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "code": "", "name": "" } response = requests.request( "POST", "{{BASE_URL}}/api/promotions", 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.