# POST /api/billing-runs Billing Runs: Creates and runs a billing run for the caller's reseller scope. A reseller caller (or an admin acting inside a reseller's context) runs that single reseller; an admin with no reseller context fans out across every reseller with billable merchants. Set `ResellerId` to run one named reseller instead: the caller's own or one beneath it (an admin may name any). Set `IsDryRun` on the input for a preview that calculates charges without generating invoices. **Operation ID:** `billingRunCreateAndRun` ## Authorization Requires: MerchantBilling.BillingRuns, MerchantBilling.BillingRuns.Create, merchant scope. Requires API key scope: `admin` Required permissions: - `MerchantBilling.BillingRuns` - `MerchantBilling.BillingRuns.Create` ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | suppressNulls | query | no | boolean | If true, omit properties with null values. | ## Request Body The period key, dry-run flag, and optional reseller. **Content type:** `application/json` Schema: [`CreateBillingRunInput`](https://devportal.demo.winkpg.io/docs/api/models/CreateBillingRunInput.md) Properties: - `periodKey` (string) required: Billing period key in yyyyMM format (e.g., "202602" for February 2026). (nullable, min length 0, max length 10) - `isDryRun` (boolean): When true, calculates charges without generating invoices (preview mode). - `resellerId` (string(uuid)): Optional reseller to run billing for. Omit it to run for the caller's own reseller (or, for an admin with no reseller selected, to bill every reseller). When set, the run bills that one reseller's merchants; a reseller caller may name their own reseller or any reseller beneath it, and an admin may name any reseller. A reseller outside the caller's scope is reported as not found. Not accepted by the all-resellers trigger. Conditional: When ResellerId is not null. (nullable) **Content type:** `text/json` Schema: [`CreateBillingRunInput`](https://devportal.demo.winkpg.io/docs/api/models/CreateBillingRunInput.md) Properties: - `periodKey` (string) required: Billing period key in yyyyMM format (e.g., "202602" for February 2026). (nullable, min length 0, max length 10) - `isDryRun` (boolean): When true, calculates charges without generating invoices (preview mode). - `resellerId` (string(uuid)): Optional reseller to run billing for. Omit it to run for the caller's own reseller (or, for an admin with no reseller selected, to bill every reseller). When set, the run bills that one reseller's merchants; a reseller caller may name their own reseller or any reseller beneath it, and an admin may name any reseller. A reseller outside the caller's scope is reported as not found. Not accepted by the all-resellers trigger. Conditional: When ResellerId is not null. (nullable) **Content type:** `application/*+json` Schema: [`CreateBillingRunInput`](https://devportal.demo.winkpg.io/docs/api/models/CreateBillingRunInput.md) Properties: - `periodKey` (string) required: Billing period key in yyyyMM format (e.g., "202602" for February 2026). (nullable, min length 0, max length 10) - `isDryRun` (boolean): When true, calculates charges without generating invoices (preview mode). - `resellerId` (string(uuid)): Optional reseller to run billing for. Omit it to run for the caller's own reseller (or, for an admin with no reseller selected, to bill every reseller). When set, the run bills that one reseller's merchants; a reseller caller may name their own reseller or any reseller beneath it, and an admin may name any reseller. A reseller outside the caller's scope is reported as not found. Not accepted by the all-resellers trigger. Conditional: When ResellerId is not null. (nullable) ## Responses ### 200 The run was created (or the fan-out was started). **Content type:** `application/json` Schema: [`BillingRunBatchResultDto`](https://devportal.demo.winkpg.io/docs/api/models/BillingRunBatchResultDto.md) Properties: - `periodKey` (string): Billing period key (yyyyMM) the batch was run for. (nullable) - `isDryRun` (boolean): True when charges were previewed without generating invoices/charges. - `wasFanOut` (boolean): True when this was an admin cross-reseller fan-out; false for a single-reseller run. Drives whether the UI shows the multi-reseller summary or the single-run message. - `isAsyncStarted` (boolean): True when the fan-out was started as a Durable background process rather than run inline: the per-reseller counts in this result are not yet populated. Callers track progress via `BillingRunBatchStatusDto` (`batchId`). - `batchId` (string(uuid)): The background batch id when `isAsyncStarted` is true; otherwise null. (nullable) - `resellersConsidered` (integer(int32)): Number of resellers evaluated (the full set considered for the run). - `resellersRun` (integer(int32)): Number of resellers for which a billing run actually executed. - `resellersSkipped` (integer(int32)): Number of resellers skipped without running: no billable merchants for the period, or a completed run already exists / is in progress for the period. - `resellersFailed` (integer(int32)): Number of resellers whose run failed. - `totalMerchantsBilled` (integer(int32)): Total merchants successfully billed across every reseller run in the batch. - `totalMerchantsFailed` (integer(int32)): Total merchants that failed within the executed reseller runs. A run can complete at the reseller level while individual merchants fail; this surfaces those so the toast severity reflects them (a fan-out with merchant failures is not a clean success). - `outcomes` (array<[BillingRunResellerOutcomeDto](https://devportal.demo.winkpg.io/docs/api/models/BillingRunResellerOutcomeDto.md)>): Per-reseller outcomes. (nullable) Fields of each item: - `resellerId` (string(uuid)) - `resellerName` (string): Display name of the reseller, when resolvable (admin fan-out only). (nullable) - `billingRunId` (string(uuid)): The created run's id, when a run executed (null for skipped resellers). (nullable) - `outcome` ([BillingRunResellerOutcome](https://devportal.demo.winkpg.io/docs/api/models/BillingRunResellerOutcome.md)): Classifies how a single reseller fared within an admin billing-run batch. Lives in Domain.Shared so the Domain aggregate (`MerchantBillingRunBatch`'s embedded outcome) and the Application.Contracts DTOs can both reference it without a layer violation. Values: - `Completed`: A run executed for the reseller (may include per-merchant failures within it). - `SkippedNoBillableMerchants`: No merchants were assigned to a price plan for the period: no run was created. - `SkippedAlreadyRun`: A completed (non-dry) run already exists for this reseller and period. - `SkippedRunInProgress`: A run is already in progress for this reseller. - `Failed`: The reseller's run failed before completion (or failed to enqueue). - `Scheduled`: The reseller's run was accepted and queued as a background job. Merchants are billed asynchronously; the run's final status (Completed, PartiallyCompleted or Failed) appears on the run once processing finishes. An all-resellers batch reports progress through the batch status instead. - `SkippedMerchantBillingDisabled`: The reseller has the "Merchant Billing" master switch (ResellerFeatures.MerchantBilling) turned off, so no run was created and no invoices were generated for its merchants. - `successCount` (integer(int32)): Merchants successfully billed in this reseller's run. - `failureCount` (integer(int32)): Merchants that failed in this reseller's run. - `totalBilledAmount` (number(double)): Total amount billed in this reseller's run. ### 403 Forbidden **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 401 Unauthorized **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 400 Bad Request **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Request failed validation_ One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing. ```json { "error": { "code": "null", "message": "Your request is not valid!", "details": "The following errors were detected during validation.", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": [ { "message": "'Amount' must be greater than 0.", "members": [ "amount" ] }, { "message": "The card has expired.", "members": [ "expirationDate" ], "code": "CardData:CardExpired" }, { "message": "'Value' must not be empty.", "members": [ "value" ], "memberPaths": [ "customFields[2].value" ] } ] } } ``` ### 404 The named reseller does not exist or is outside the caller's reseller scope. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Resource not found_ The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message. ```json { "error": { "code": "null", "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` ### 501 Not Implemented **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 500 Internal Server Error **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 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](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Business rule refused the request_ The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code. ```json { "error": { "code": "Transactions:OperationNotAllowed", "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` ### 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`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md) 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. (nullable) - `title` (string) required: A short, human-readable summary of the problem type. (nullable) - `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. (nullable) - `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`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ## 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 CreateBillingRunInput. See the Request body section below for its fields. ### cURL ```bash curl -X POST "{{BASE_URL}}/api/billing-runs" \ -H "api-key: {{API_KEY}}" \ -H "Content-Type: application/json" \ -d '{ "periodKey": "" }' ``` ### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $body = @' { "periodKey": "" } '@ $response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/billing-runs' ` -Headers $headers -ContentType 'application/json' -Body $body ``` ### TypeScript (SDK) ```bash npm install @winkpg/winkpg-api ``` ```typescript import { Configuration, MerchantBillingApi } from '@winkpg/winkpg-api'; const api = new MerchantBillingApi(new Configuration({ basePath: '{{BASE_URL}}', apiKey: '{{API_KEY}}', })); const { data } = await api.billingRunCreateAndRun({ "periodKey": "" }); ``` ### TypeScript (raw HTTP) ```typescript const response = await fetch('{{BASE_URL}}/api/billing-runs', { method: 'POST', headers: { "api-key": "{{API_KEY}}", "Content-Type": "application/json", }, body: JSON.stringify({ "periodKey": "" }), }); 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 MerchantBillingApi(config); var body = JsonSerializer.Deserialize(""" { "periodKey": "" } """); var result = await api.BillingRunCreateAndRunAsync(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/billing-runs"); request.Headers.Add("api-key", "{{API_KEY}}"); request.Content = new StringContent(""" { "periodKey": "" } """, 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.MerchantBillingApi(client) body = winkpg_api.CreateBillingRunInput.from_dict({ "periodKey": "" }) result = api.billing_run_create_and_run(body) ``` ### Python (raw HTTP) ```bash pip install requests ``` ```python import requests headers = { "api-key": "{{API_KEY}}", "Content-Type": "application/json", } body = { "periodKey": "" } response = requests.request( "POST", "{{BASE_URL}}/api/billing-runs", headers=headers, json=body, ) response.raise_for_status() data = response.json() ``` ## See also - [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.