Billing Runs: Creates and runs a billing run for the caller's reseller scope.

POST /api/billing-runs deprecated

Requires: MerchantBilling.BillingRuns, MerchantBilling.BillingRuns.Create, merchant 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.

Try this in the console

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

cURL

curl -X POST "{{BASE_URL}}/api/billing-runs" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "periodKey": ""
}'

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

npm install @winkpg/winkpg-api

TypeScript (SDK)

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)

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

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 MerchantBillingApi(config);
var body = JsonSerializer.Deserialize<CreateBillingRunInput>("""
    {
      "periodKey": ""
    }
    """);

var result = await api.BillingRunCreateAndRunAsync(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/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();

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.MerchantBillingApi(client)
    body = winkpg_api.CreateBillingRunInput.from_dict({
      "periodKey": ""
    })
    result = api.billing_run_create_and_run(body)

pip install requests

Python (raw HTTP)

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

Parameters

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

Request body

application/json , required

Field	Type	Description
`periodKey` required	string	Billing period key in yyyyMM format (e.g., "202602" for February 2026). nullablemin length 0max length 10
`isDryRun` required	boolean	When true, calculates charges without generating invoices (preview mode).
`resellerId` required	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

This request body has no documented fields.