The API reference is not available right now

This instance could not load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such operation

This instance does not document an operation under that identifier. It may have been renamed, or it may belong to a feature this installation does not have enabled.

Back to the API reference

API reference Merchant Billing

Billing Runs: Gets one merchant's billing history across every run that included it.

GET /api/billing-runs/merchant-history deprecated

Requires: MerchantBilling.BillingRuns, merchant scope.

Returns the merchant's per-run results. The reseller scope is resolved server-side from the merchant, so reseller users can only query merchants under their own reseller.

Parameters

Name In Type Description
MerchantId required query string (uuid) The merchant whose billing history is requested. The owning reseller scope is resolved server-side from this merchant — callers cannot supply a reseller.
PeriodKey required query string Filter by period key (yyyyMM).
ResultStatus required query PhoeniXGateMerchantBillingMerchantBillingRunResultStatus Filter by this merchant's per-run result status.
IncludeDryRuns required query boolean When `false` (default) dry (preview) runs are excluded — history shows real billing only. Set `true` to include previews.
CreatedFrom required query string (date-time) Inclusive lower bound on the run's creation time.
CreatedTo required query string (date-time) Exclusive upper bound on the run's creation time (the date-range chip emits next-day-exclusive bounds).
Filter.Logic required query PhoenixAbpCoreDataFilteringFilterLogic
Filter.Rules required query array of PhoenixAbpCoreDataFilteringFilterRule
Filter.Groups required query array of PhoenixAbpCoreDataFilteringFilterGroup
MaxResultCount required query integer (int32)
ContinuationToken required query string
Sorting.Field required query string
Sorting.Descending required query boolean
IncludeDeleted required query boolean
IncludeInactive required query boolean
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 requested page of merchant billing history.

Field Type Description

This response has no documented body fields.

404 No merchant exists with the specified id (or it is outside the caller's reseller scope).

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.

Codes declared by Merchant Billing

Authentication