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.

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.
`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.
`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.