# GET /api/customers/recurring-billing/runs/{id}

Get the detail of a specific billing run, including per-contract items.

**Required permissions**: `Customers.RecurringBilling.ViewHistory`  
**Scope**: merchant

**Operation ID:** `recurringBillingGetRunDetail`

## Authorization

Requires: Customers.RecurringBilling.ViewHistory, merchant scope.

Requires API key scope: `reports`

Required permissions:
- `Customers.RecurringBilling.ViewHistory`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| id | path | yes | string(uuid) | The billing run document ID. |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Responses

### 200

OK

**Content type:** `application/json`

Schema: [`RecurringBillingRunDetailDto`](https://devportal.demo.winkpg.io/docs/api/models/RecurringBillingRunDetailDto.md)

Properties:
- `summary` ([RecurringBillingRunSummaryDto](https://devportal.demo.winkpg.io/docs/api/models/RecurringBillingRunSummaryDto.md)): Summary data for this run.
  Fields:
  - `id` (string(uuid)): The document ID.
  - `runId` (string(uuid)): Links all per-merchant run documents from the same workflow execution.
  - `merchantId` (string(uuid)): The merchant this run was executed for.
  - `runDate` (string(date-time)): The business date of this billing run.
  - `triggerType` ([RecurringBillingTriggerType](https://devportal.demo.winkpg.io/docs/api/models/RecurringBillingTriggerType.md)): Whether this run was auto or manually triggered.
    Values:
    - `Auto`: Triggered automatically by the scheduled cron job.
    - `Manual`: Triggered manually by an administrator via the API or UI.
  - `contractCount` (integer(int32)): Number of contracts processed.
  - `successCount` (integer(int32)): Number of successful billing attempts.
  - `failedCount` (integer(int32)): Number of failed billing attempts.
  - `skippedCount` (integer(int32)): Number of skipped contracts (already billed).
  - `totalAmount` (number(double)): Total amount billed across all contracts.
  - `status` ([RecurringBillingRunStatus](https://devportal.demo.winkpg.io/docs/api/models/RecurringBillingRunStatus.md)): Execution status.
    Values:
    - `Pending`: The run has been created but not yet started.
    - `Running`: The run is currently executing.
    - `Completed`: All contracts in the run were processed successfully.
    - `Failed`: The run failed entirely (infrastructure or unrecoverable error).
    - `PartiallyCompleted`: Some contracts succeeded and some failed.
  - `correlationId` (string(uuid)): Correlation identifier for distributed tracing. (nullable)
  - `durationMs` (integer(int64)): Total duration of the run in milliseconds. (nullable)
  - `creationTime` (string(date-time)): When this run was created.
- `triggeredByUserId` (string(uuid)): The user who triggered this run (manual triggers only). (nullable)
- `triggeredByUserName` (string): Display name of the triggering user. (nullable)
- `notes` (string): Notes provided with the manual trigger. (nullable)
- `instanceId` (string): Identifier of the background job that processed this run. (nullable)
- `errorMessage` (string): Error message if the run failed. (nullable)
- `errorDetails` (array<[RecurringBillingRunErrorDetailDto](https://devportal.demo.winkpg.io/docs/api/models/RecurringBillingRunErrorDetailDto.md)>): Structured failure chain for admin-only diagnostic display. Null unless the caller  holds `CustomersPermissions.RecurringBilling.ViewErrorDetails`. Each frame is  one link of the exception / Durable `FailureDetails` tree (outer-first). (nullable)
  Fields of each item:
  - `errorType` (string): Fully qualified CLR type of the exception (or Durable `FailureDetails.ErrorType`). (nullable)
  - `errorMessage` (string): Human-readable exception message. (nullable)
  - `stackTrace` (string): Demystified stack trace for the frame, if available. (nullable)
- `items` (array<[RecurringBillingRunItemDto](https://devportal.demo.winkpg.io/docs/api/models/RecurringBillingRunItemDto.md)>): Per-contract billing outcomes. (nullable)
  Fields of each item:
  - `contractId` (string(uuid)): The contract that was billed.
  - `customerId` (string(uuid)): The customer who owns the contract.
  - `amountBilled` (number(double)): Amount charged.
  - `success` (boolean): Whether the billing attempt was successful.
  - `skipped` (boolean): Whether the contract was skipped (already billed).
  - `transactionId` (string(uuid)): The transaction created in the payment engine. (nullable)
  - `failureReason` (string): Failure reason if the billing attempt failed. (nullable)
  - `processorResponseCode` (string): Payment processor response code. (nullable)
  - `processorMessage` (string): Payment processor message. (nullable)
  - `executedAt` (string(date-time)): When the billing execution started. (nullable)
  - `completedAt` (string(date-time)): When the billing execution completed. (nullable)
  - `persistenceFailed` (boolean): True when the contract was charged successfully (`success` = true,  `transactionId` populated) but the customer document update that  would have written the new `ExecutionHistory` record and advanced  `NextScheduledRun` failed at `SaveChangesAsync`. The charge stands;  the contract's local view of it is missing until the next billing cycle replays  the persistence step (deterministic `IdempotencyKey` prevents re-charge).  Null when the row's persistence either succeeded or never ran (skipped/failed). (nullable)
  - `persistenceFailureReason` (string): Short label naming the exception type that caused `persistenceFailed`  (e.g. `"DbUpdateException"`). Surfaced in the run detail UI so operators can  distinguish a transient concurrency conflict from a structural shape bug without leaving  the page. Null when `persistenceFailed` is null. (nullable)
  - `preCreditAmount` (number(double)): The contract amount this cycle was priced at before any proration credit, pre-surcharge. Null  on items written before proration existed and on skips that resolved no amount. (nullable)
  - `creditApplied` (number(double)): The proration credit taken off this charge, or null when none applied. (nullable)
  - `chargedAmount` (number(double)): The contract amount submitted after the credit, pre-surcharge. Zero for a cycle the credit  covered in full; null on items written before proration existed and on skips. (nullable)
  - `planPriceId` (string(uuid)): The plan price revision this contract was billed under, or null when the contract carries no  plan and on items written before the field existed. (nullable)
  - `planPriceTotalAmount` (number(double)): What that revision charges per cycle, resolved from the merchant's plan catalog once for the  whole run. Null whenever `planPriceId` is, and also when the revision can no  longer be read: the plan it belonged to has since been deleted, or the catalog read failed. (nullable)
  - `planPriceEffectiveFrom` (string(date-time)): When that revision started applying, in UTC. Null under the same conditions as  `planPriceTotalAmount`. (nullable)
  - `skipCategory` ([RecurringBillingSkipCategory](https://devportal.demo.winkpg.io/docs/api/models/RecurringBillingSkipCategory.md)): Why the run did not charge this contract, or null when it did or tried to. Set for every  skipped item, and for a failed item whose consent state could not be read. Null on items  recorded before this field existed. (nullable)
    Values:
    - `AlreadyBilled`: The contract already has a successful charge for this scheduled run. Harmless: nothing is owed, and nothing needs attention.
    - `MerchantIneligible`: The merchant that owns the contract is missing, deleted, or inactive.
    - `InvalidContract`: The contract's own per-bill amount is zero or less, so there is nothing to charge.
    - `PlanUnresolved`: The contract subscribes to a plan whose price could not be read, so the amount is unknown.
    - `MissingConsent`: The stored payment method has no active stored-credential consent that permits a recurring charge.
    - `ConsentLookupUnavailable`: The platform could not read the stored payment method's consent state. A platform fault rather than a configuration problem, recorded as a failed run item, and retried on the next run.

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

**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: [`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

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 GET "{{BASE_URL}}/api/customers/recurring-billing/runs/{id}" \
  -H "api-key: {{API_KEY}}"
```

### PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/customers/recurring-billing/runs/{id}' `
    -Headers $headers
```

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
import { Configuration, RecurringBillingApi } from '@winkpg/winkpg-api';

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

const { data } = await api.recurringBillingGetRunDetail("3fa85f64-5717-4562-b3fc-2c963f66afa6");
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/customers/recurring-billing/runs/{id}', {
  method: 'GET',
  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 RecurringBillingApi(config);
var result = await api.RecurringBillingGetRunDetailAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"));
```

### C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/customers/recurring-billing/runs/{id}");
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.RecurringBillingApi(client)
    result = api.recurring_billing_get_run_detail("3fa85f64-5717-4562-b3fc-2c963f66afa6")
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/customers/recurring-billing/runs/{id}",
    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.