Billing Runs: Gets the active all-resellers batch, or the most recent batch.

GET /api/billing-runs/batch deprecated

Requires: MerchantBilling.BillingRuns, merchant scope.

Returns the in-progress batch if one exists, otherwise the most recent batch. Returns 204 No Content when none has ever run, or for callers that are not an admin with no reseller context.

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

cURL PowerShell TypeScript C# Python

cURL

curl -X GET "{{BASE_URL}}/api/billing-runs/batch" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/billing-runs/batch' `
    -Headers $headers

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

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/billing-runs/batch', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new MerchantBillingApi(config);
var result = await api.BillingRunGetActiveOrLatestBatchAsync();

C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/billing-runs/batch");
request.Headers.Add("api-key", "{{API_KEY}}");

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)
    result = api.billing_run_get_active_or_latest_batch()

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/billing-runs/batch",
    headers=headers,
)
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

This request body has no documented fields.

Responses

200 The active or latest batch status.

Body: BillingRunBatchStatusDto Each item has these fields.

Field	Type	Description
`batchId` required	string (uuid)	Batch document id (the tracking id returned at trigger time).
`orchestrationInstanceId` required	string	Identifier of the background job processing the batch. Null until processing has started. nullable
`periodKey` required	string	Billing period key (yyyyMM) the batch is running for. nullable
`isDryRun` required	boolean	True when charges are previewed without generating invoices/charges.
`status` required	all of MerchantBillingRunBatchStatus	Current batch status.
`triggeredByUserId` required	string (uuid)	User that triggered the batch. nullable
`triggeredByUserName` required	string	Display name of the user that triggered the batch. nullable
`startedAt` required	string (date-time)	When the fan-out workflow started processing. nullable
`completedAt` required	string (date-time)	When the batch reached a terminal status. nullable
`clearedByUserName` required	string	Display name of the admin that force-cleared the batch, when `status` is `Cleared`. nullable
`resellersConsidered` required	integer (int32)
`resellersRun` required	integer (int32)
`resellersSkipped` required	integer (int32)
`resellersFailed` required	integer (int32)
`totalMerchantsBilled` required	integer (int32)
`totalMerchantsFailed` required	integer (int32)
`outcomes` required	array of BillingRunResellerOutcomeDto	Per-reseller outcomes (populated once the batch completes). nullable
`isInProgress` required	boolean	True while the batch is non-terminal (Pending or Running). read only

This response has no documented body fields.

204 No batch applies for this caller.

Body: Each item has these fields.

Field	Type	Description

This response has no body.

403 Forbidden

Body: RemoteServiceErrorResponse Each item has these fields.

Field	Type	Description
`error` required	RemoteServiceErrorInfo

This response has no documented body fields.

401 Unauthorized

Body: RemoteServiceErrorResponse Each item has these fields.

Field	Type	Description
`error` required	RemoteServiceErrorInfo

This response has no documented body fields.

400 Bad Request

Body: RemoteServiceErrorResponse Each item has these fields.

Field	Type	Description
`error` required	RemoteServiceErrorInfo

This response has no documented body fields.

404 Not Found

Body: RemoteServiceErrorResponse Each item has these fields.

Field	Type	Description
`error` required	RemoteServiceErrorInfo

This response has no documented body fields.

501 Not Implemented

Body: RemoteServiceErrorResponse Each item has these fields.

Field	Type	Description
`error` required	RemoteServiceErrorInfo

This response has no documented body fields.

500 Internal Server Error

Body: RemoteServiceErrorResponse Each item has these fields.

Field	Type	Description
`error` required	RemoteServiceErrorInfo

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. See the error-code reference in this document's description for the values `error.code` can take.

Body: RemoteServiceErrorResponse Each item has these fields.

Field	Type	Description
`error` required	RemoteServiceErrorInfo

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 Each item has these fields.

Field	Type	Description
`error` required	RemoteServiceErrorInfo

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 Merchant Billing

The API reference isn't available right now

No such operation

This reference may be out of date

Billing Runs: Gets the active all-resellers batch, or the most recent batch.

Example request

Parameters

Request body

Responses

200 The active or latest batch status.

204 No batch applies for this caller.

403 Forbidden

401 Unauthorized

400 Bad Request

404 Not Found

501 Not Implemented

500 Internal Server Error

Errors

Authentication