# GET /api/billing-runs

Billing Runs: Gets a continuation-token paged list of billing runs in the caller's reseller scope.

**Required permissions**: `MerchantBilling.BillingRuns`  
**Scope**: merchant

**Operation ID:** `GET_api_billing-runs`

## Authorization

Requires: MerchantBilling.BillingRuns, merchant scope.

Required permissions:
- `MerchantBilling.BillingRuns`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| ResellerId | query | no | string(uuid) | Optional reseller drill-down. Honored only for admin callers; reseller users are  always scoped to their own reseller regardless of this value. |
| Status | query | no | PhoeniXGateMerchantBillingMerchantBillingRunStatus | Filter by billing run status. |
| PeriodKey | query | no | string | Filter by period key. |
| IsDryRun | query | no | boolean | Filter by dry-run flag. |
| Filter.Logic | query | no | PhoenixAbpCoreDataFilteringFilterLogic |  |
| Filter.Rules | query | no | array<PhoenixAbpCoreDataFilteringFilterRule> |  |
| Filter.Groups | query | no | array<PhoenixAbpCoreDataFilteringFilterGroup> |  |
| MaxResultCount | query | no | integer(int32) |  |
| ContinuationToken | query | no | string |  |
| Sorting.Field | query | no | string |  |
| Sorting.Descending | query | no | boolean |  |
| IncludeDeleted | query | no | boolean |  |
| IncludeInactive | query | no | boolean |  |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Responses

### 200

The requested page of billing runs.

**Content type:** `text/plain`

Schema: `PhoenixAbpCoreApplicationContractsContinuationPagedResultDtoOfPhoeniXGateMerchantBillingBillingRunsBillingRunDto`

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

Schema: `PhoenixAbpCoreApplicationContractsContinuationPagedResultDtoOfPhoeniXGateMerchantBillingBillingRunsBillingRunDto`

**Content type:** `text/json`

Schema: `PhoenixAbpCoreApplicationContractsContinuationPagedResultDtoOfPhoeniXGateMerchantBillingBillingRunsBillingRunDto`

### 403

Forbidden

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 401

Unauthorized

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 400

Bad Request

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 404

Not Found

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 501

Not Implemented

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 500

Internal Server Error

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

## See also

- [All documentation](https://docs.winkpg.io/llms.txt): the machine-readable index of every public page on this site.