# POST /api/customers/recurring-billing/sandbox/run-now Run the calling sandbox key's merchant's recurring billing now. 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. **Operation ID:** `sandboxRecurringBillingRunNow` ## Authorization Requires: Customers.RecurringBilling.TriggerSandbox, merchant scope. Requires API key scope: `transactions:write` Required permissions: - `Customers.RecurringBilling.TriggerSandbox` ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | suppressNulls | query | no | boolean | If true, omit properties with null values. | ## Responses ### 200 OK **Content type:** `application/json` Schema: [`SandboxRecurringBillingRunResultDto`](https://devportal.demo.winkpg.io/docs/api/models/SandboxRecurringBillingRunResultDto.md) Properties: - `merchantId` (string(uuid)): The merchant this run acted on, resolved from the caller's own credential. - `advancedContractCount` (integer(int32)): How many contracts had their next scheduled run brought forward to now. - `billedContractCount` (integer(int32)): How many contracts the engine charged successfully. - `failedContractCount` (integer(int32)): How many contracts the engine attempted and failed to charge. - `skippedContractCount` (integer(int32)): How many contracts the engine passed over without charging. - `totalAmount` (number(double)): The gross amount the successful charges carried. - `runId` (string(uuid)): The billing run record this produced, as it appears in recurring billing history. - `contracts` (array<[SandboxRecurringBillingContractResultDto](https://devportal.demo.winkpg.io/docs/api/models/SandboxRecurringBillingContractResultDto.md)>): What happened to each contract the run touched. (nullable) Fields of each item: - `contractId` (string(uuid)): The contract this entry is about. - `customerId` (string(uuid)): The customer that owns the contract. - `success` (boolean): Whether the charge was approved. - `skipped` (boolean): Whether the contract was passed over rather than charged. - `amountBilled` (number(double)): The amount charged, when the charge was attempted. - `transactionId` (string(uuid)): The transaction the charge produced, when one was created. (nullable) - `failureReason` (string): Why the contract was skipped or the charge failed, when either happened. (nullable) - `processorResponseCode` (string): The processor's response code, when the charge reached a processor. (nullable) ### 403 Forbidden **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 401 Unauthorized **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 400 Bad Request **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Request failed validation_ One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing. ```json { "error": { "code": "null", "message": "Your request is not valid!", "details": "The following errors were detected during validation.", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": [ { "message": "'Amount' must be greater than 0.", "members": [ "amount" ] }, { "message": "The card has expired.", "members": [ "expirationDate" ], "code": "CardData:CardExpired" }, { "message": "'Value' must not be empty.", "members": [ "value" ], "memberPaths": [ "customFields[2].value" ] } ] } } ``` ### 404 Not Found **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Resource not found_ The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message. ```json { "error": { "code": "null", "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` ### 501 Not Implemented **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 500 Internal Server Error **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 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](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Business rule refused the request_ The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code. ```json { "error": { "code": "Transactions:OperationNotAllowed", "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` ### 429 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. A sandbox request whose merchant has spent the plan's transaction allowance is refused with a different `application/json` body: `code` is `USAGE_BUDGET_EXCEEDED`, and `limit` and `used` report the allowance. `Retry-After` is sent only when the allowance resets. An allowance that never resets sends none, and retrying won't help. **Content type:** `application/problem+json` Schema: [`RateLimitProblemDetails`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md) Properties: - `type` (string) required: 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` (string) required: A short, human-readable summary of the problem type. (nullable) - `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines. - `detail` (string) required: A human-readable explanation of this occurrence of the problem. (nullable) - `retryAfterSeconds` (integer(int32)) required: 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. **Content type:** `application/json` Schema type: `object` ## 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. ### cURL ```bash curl -X POST "{{BASE_URL}}/api/customers/recurring-billing/sandbox/run-now" \ -H "api-key: {{API_KEY}}" ``` ### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/customers/recurring-billing/sandbox/run-now' ` -Headers $headers ``` ### TypeScript (SDK) ```bash npm install @winkpg/winkpg-api ``` ```typescript 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) ```typescript 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(); ``` ### C# (SDK) ```bash dotnet add package WinkPg.Api.Client ``` ```csharp 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) ```csharp 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(); ``` ### Python (SDK) ```bash pip install winkpg-api ``` ```python 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() ``` ### Python (raw HTTP) ```bash pip install requests ``` ```python 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() ``` ## See also - [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.