Billing Runs: Cancels a pending or running billing run.

POST /api/billing-runs/{id}/cancel deprecated

Requires: MerchantBilling.BillingRuns, MerchantBilling.BillingRuns.Create, merchant scope.

The optional cancellation reason is supplied in the request body (not the query string) so the free-text note is not captured by ingress/access logs, proxies, or APM. The body is optional: an empty body cancels the run with no attributed reason.

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

cURL PowerShell TypeScript C# Python

cURL

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

PowerShell

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

$body = @'
{
  "reason": ""
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/billing-runs/{id}/cancel' `
    -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.billingRunCancel("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "reason": ""
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/billing-runs/{id}/cancel', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "reason": ""
  }),
});

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<CancelBillingRunInput>("""
    {
      "reason": ""
    }
    """);

var result = await api.BillingRunCancelAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), 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/{id}/cancel");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "reason": ""
    }
    """, 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.CancelBillingRunInput.from_dict({
      "reason": ""
    })
    result = api.billing_run_cancel("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "reason": ""
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/billing-runs/{id}/cancel",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`id` required	path	string (uuid)	The billing run identifier.
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`reason` required	string	Optional free-text reason recorded on the run for cancellation attribution. Bounded by `MaxCancelReasonLength`; leave null or blank when no note is needed. nullablemax length 512

This request body has no documented fields.

Responses

204 The billing run was cancelled.

Body: Each item has these fields.

Field	Type	Description

This response has no body.