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.
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.
| Field | Type | Description |
|---|
This response has no documented body fields.
404 No price plan exists with the specified id.
| Field | Type | Description |
|---|
This response has no documented body fields.
403 Forbidden
| Field | Type | Description |
|---|
This response has no documented body fields.
401 Unauthorized
| Field | Type | Description |
|---|
This response has no documented body fields.
400 Bad Request
| Field | Type | Description |
|---|
This response has no documented body fields.
501 Not Implemented
| Field | Type | Description |
|---|
This response has no documented body fields.
500 Internal Server Error
| Field | Type | Description |
|---|
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.
| Field | Type | Description |
|---|
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.