Billing Runs: Gets the plan-scoped historic billing report.
GET
/api/billing-runs/price-plan-history
deprecated
Requires: MerchantBilling.BillingRuns, MerchantBilling.Reports, merchant scope.
Returns every billing-run result where a merchant was billed against the given price plan, across the requested period range (default trailing 12 months). Row fields are run-time snapshots.
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.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
PricePlanId
required |
query | string (uuid) | The price plan whose billing history is requested. |
FromPeriodKey
required |
query | string | Inclusive start of the period range in yyyyMM format (e.g., "202506"). When omitted, defaults to the trailing 12 months ending at the current period. |
ToPeriodKey
required |
query | string | Inclusive end of the period range in yyyyMM format (e.g., "202606"). When omitted, defaults to the current period. |
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.
Responses
200 The plan-scoped history report.
Body: PricePlanHistoryDto
Each item has these fields.
| Field | Type | Description |
|---|---|---|
pricePlanId
required |
string (uuid) | The price plan the report is scoped to. |
currentPlanName
required |
string | The plan's <b>current</b> name (row-level names are run-time snapshots). nullable |
fromPeriodKey
required |
string | Inclusive start of the effective period range (yyyyMM). nullable |
toPeriodKey
required |
string | Inclusive end of the effective period range (yyyyMM). nullable |
rows
required |
array of PricePlanHistoryRowDto | Report rows, sorted by merchant name then period. nullable |
This response has no documented body fields.
404 No price plan exists with the specified id.
Body:
Each item has these fields.
| Field | Type | Description |
|---|
This response has no body.
403 Forbidden
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
401 Unauthorized
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
400 Bad Request
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
501 Not Implemented
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
500 Internal Server Error
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
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.
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
429 The request was refused because a rate limit was exceeded. 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.
Body: RateLimitProblemDetails
Each item has these fields.
| Field | Type | Description |
|---|---|---|
type
required |
string | 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
required |
string | A short, human-readable summary of the problem type. nullable |
status
required |
integer (int32) | The HTTP status code, repeated in the body as the problem-details format defines. |
detail
required |
string | A human-readable explanation of this occurrence of the problem. nullable |
retryAfterSeconds
required |
integer (int32) | 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. |
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.