Billing Runs: Gets one merchant's billing history across every run that included it.

GET /api/billing-runs/merchant-history deprecated

Requires: MerchantBilling.BillingRuns, merchant scope.

Returns the merchant's per-run results. The reseller scope is resolved server-side from the merchant, so reseller users can only query merchants under their own reseller.

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

cURL PowerShell TypeScript C# Python

cURL

curl -X GET "{{BASE_URL}}/api/billing-runs/merchant-history?MerchantId=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/billing-runs/merchant-history?MerchantId=3fa85f64-5717-4562-b3fc-2c963f66afa6' `
    -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.billingRunGetMerchantHistory("3fa85f64-5717-4562-b3fc-2c963f66afa6");

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/billing-runs/merchant-history?MerchantId=3fa85f64-5717-4562-b3fc-2c963f66afa6', {
  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.BillingRunGetMerchantHistoryAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"));

C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/billing-runs/merchant-history?MerchantId=3fa85f64-5717-4562-b3fc-2c963f66afa6");
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_merchant_history("3fa85f64-5717-4562-b3fc-2c963f66afa6")

pip install requests

Python (raw HTTP)

import requests

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

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/billing-runs/merchant-history?MerchantId=3fa85f64-5717-4562-b3fc-2c963f66afa6",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`MerchantId` required	query	string (uuid)	The merchant whose billing history is requested. The owning reseller scope is resolved server-side from this merchant: callers cannot supply a reseller.
`PeriodKey` required	query	string	Filter by period key (yyyyMM).
`ResultStatus` required	query	MerchantBillingRunResultStatus	Filter by this merchant's per-run result status.
`IncludeDryRuns` required	query	boolean	When `false` (default) dry (preview) runs are excluded: history shows real billing only. Set `true` to include previews.
`CreatedFrom` required	query	string (date-time)	Inclusive lower bound on the run's creation time.
`CreatedTo` required	query	string (date-time)	Exclusive upper bound on the run's creation time (the date-range chip emits next-day-exclusive bounds).
`Filter.Logic` required	query	FilterLogic
`Filter.Rules` required	query	array of FilterRule
`Filter.Groups` required	query	array of FilterGroup
`MaxResultCount` required	query	integer (int32)
`ContinuationToken` required	query	string
`Sorting.Field` required	query	string
`Sorting.Descending` required	query	boolean
`IncludeDeleted` required	query	boolean
`IncludeInactive` required	query	boolean
`IncludeApproxTotalCount` required	query	boolean	Set to false to skip the approximate total count query and receive a null count; omit the value or set it to true to receive the count as before.
`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 requested page of merchant billing history.

Body: ContinuationPagedResultDtoOfMerchantBillingHistoryItemDto Each item has these fields.

Field	Type	Description
`items` required	array of MerchantBillingHistoryItemDto	The items returned for this page. nullable
`nextContinuationToken` required	string	Continuation token to use when requesting the next page. Null means no additional pages exist. nullable
`approxTotalCount` required	integer (int64)	An approximate total count of matching items. This value is optional and may be stale or estimated, so treat it as an approximation. nullable
`pageItemCount` required	integer (int32)	Convenience property for the number of items in this page. read only
`retrievedAt` required	string (date-time)	When the page was retrieved. Useful for diagnostics and cache behavior.

This response has no documented body fields.

404 No merchant exists with the specified id (or it is outside the caller's reseller scope).

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.

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

Body: RateLimitProblemDetails Each item has these fields.

Field	Type	Description
`type` required	string	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` required	string	A short, human-readable summary of the problem type. nullable
`status` required	integer (int32)	The HTTP status code, repeated in the body as the problem-details format defines.
`detail` required	string	A human-readable explanation of this occurrence of the problem. nullable
`retryAfterSeconds` required	integer (int32)	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.

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 one merchant's billing history across every run that included it.

Example request

Parameters

Request body

Responses

200 The requested page of merchant billing history.

404 No merchant exists with the specified id (or it is outside the caller's reseller scope).

403 Forbidden

401 Unauthorized

400 Bad Request

501 Not Implemented

500 Internal Server Error

429 The request was refused because a rate limit was exceeded. 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.

Errors

Authentication