Run the calling sandbox key's merchant's recurring billing now.

POST /api/customers/recurring-billing/sandbox/run-now deprecated

Requires: Customers.RecurringBilling.TriggerSandbox, merchant scope.

Brings the merchant's active contracts due, bills them through the real engine, and answers only once it has, so the transactions and their webhooks are there to look at as soon as the response arrives. Sandbox only: a key stamped for the live world is refused, so is a test key whose merchant has gone live, and so is a caller carrying no environment stamp at all. A merchant with no active contracts gets a success carrying zero counts rather than a refusal, so a script can send this unconditionally.

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 POST "{{BASE_URL}}/api/customers/recurring-billing/sandbox/run-now" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/customers/recurring-billing/sandbox/run-now' `
    -Headers $headers

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, SandboxRecurringBillingApi } from '@winkpg/winkpg-api';

const api = new SandboxRecurringBillingApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.sandboxRecurringBillingRunNow();

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/customers/recurring-billing/sandbox/run-now', {
  method: 'POST',
  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 SandboxRecurringBillingApi(config);
var result = await api.SandboxRecurringBillingRunNowAsync();

C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/customers/recurring-billing/sandbox/run-now");
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.SandboxRecurringBillingApi(client)
    result = api.sandbox_recurring_billing_run_now()

pip install requests

Python (raw HTTP)

import requests

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

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/customers/recurring-billing/sandbox/run-now",
    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.