Billing Runs: Counts the merchants a run bills that their plan does not price.

GET /api/billing-runs/environment-coverage deprecated

Requires: MerchantBilling.BillingRuns, merchant scope.

Requires API key scope: admin (Administration)

Counts the merchants a run for the reseller and period would bill, and how many of them meter into a SKU family their plan has no enabled rate entry for: a Sandbox merchant on a plan with no sandbox rate entries, or a Production merchant on a plan with no production rate entries. Those merchants are billed custom items only. Counts only; no merchant or plan is named. The reseller is the caller's own or one beneath it; any other reseller returns 404.

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/environment-coverage?ResellerId=3fa85f64-5717-4562-b3fc-2c963f66afa6&PeriodKey=PERIOD_KEY" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/billing-runs/environment-coverage?ResellerId=3fa85f64-5717-4562-b3fc-2c963f66afa6&PeriodKey=PERIOD_KEY' `
    -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.billingRunGetEnvironmentCoverage("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PERIOD_KEY");

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/billing-runs/environment-coverage?ResellerId=3fa85f64-5717-4562-b3fc-2c963f66afa6&PeriodKey=PERIOD_KEY', {
  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.BillingRunGetEnvironmentCoverageAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), "PERIOD_KEY");

C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/billing-runs/environment-coverage?ResellerId=3fa85f64-5717-4562-b3fc-2c963f66afa6&PeriodKey=PERIOD_KEY");
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_environment_coverage("3fa85f64-5717-4562-b3fc-2c963f66afa6", "PERIOD_KEY")

pip install requests

Python (raw HTTP)

import requests

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

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/billing-runs/environment-coverage?ResellerId=3fa85f64-5717-4562-b3fc-2c963f66afa6&PeriodKey=PERIOD_KEY",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description

ResellerId required

query

string (uuid)

The reseller whose assigned merchants to count: the caller's own reseller or a live descendant of it (an admin may name any reseller). A reseller outside the caller's scope is reported as not found.

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.

PeriodKey required

query

string

The billing period in `yyyyMM` format. Only merchants whose assignment window overlaps the period are counted, the same set a run for that period bills.

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.

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

This request body has no documented fields.

Responses

200 OK

The counts for the reseller and period.

Body: BillingRunEnvironmentCoverageDto BillingRunEnvironmentCoverageDto Each item has these fields.

Field Type Description

assignedMerchantCount required

integer (int32)

Merchants a run for the period would bill: active, assigned a price plan, with an assignment window that overlaps the period. The reseller's collection merchant is not counted.

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.

unpricedSandboxMerchantCount required

integer (int32)

Assigned merchants that meter into the sandbox SKU family (every environment except Production) whose plan has no enabled sandbox rate entry.

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.

unpricedProductionMerchantCount required

integer (int32)

Assigned merchants in the Production environment whose plan has no enabled production rate entry.

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 Too Many Requests

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 400 401 403 404 500 501 default

400 Bad Request Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why.
401 Unauthorized Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired.
403 Forbidden Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason.
404 Not Found The reseller does not exist or is outside the caller's scope.
500 Internal Server Error Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`.
501 Not Implemented Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help.
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.

Fields of RemoteServiceErrorInfo:

Field Type Description

code required

string

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.

message required

string

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.

details required

string

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.

data required

object

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.

validationErrors required

array of RemoteServiceValidationErrorInfo array of RemoteServiceValidationErrorInfo

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.

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

Authentication

ApiKey with scopes

The API reference isn't available right now

No such operation

This reference may be out of date

Billing Runs: Counts the merchants a run bills that their plan does not price.

Example request

Parameters

Request body

Responses

Errors

Authentication