WinkPG Docs

View as Markdown

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:57 UTC.

`PricePlanHistoryDto`

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Plan-scoped historic billing report: every billing-run outcome where a merchant was billed against the requested price plan, ordered by merchant then period.

Values

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields

Field Type Description

pricePlanId required

string (uuid)

The price plan the report is scoped to.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

currentPlanName required

string

The plan's <b>current</b> name (row-level names are run-time snapshots). nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

fromPeriodKey required

string

Inclusive start of the effective period range (yyyyMM). nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

toPeriodKey required

string

Inclusive end of the effective period range (yyyyMM). nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

rows required

array of PricePlanHistoryRowDto array of PricePlanHistoryRowDto

Report rows, sorted by merchant name then period. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of each PricePlanHistoryRowDto:

Field Type Description

merchantId required

string (uuid)

The billed merchant. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

merchantName required

string

Merchant name snapshot at billing time. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

periodKey required

string

Billing period key (yyyyMM). nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

planNameSnapshot required

string

Price plan name snapshot at billing time. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

totalFees required

number (double)

Total sell-side fees charged to the merchant for the period. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

paymentStatus required

PricePlanHistoryPaymentStatus PricePlanHistoryPaymentStatus

Coarse payment status derived from the run-result status.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`NotApplicable`	Not applicable: the merchant was not billed (skipped/unresolved).
`Paid`	Charge confirmed (recurring path reconciled).
`Pending`	Awaiting payment: invoice issued or charge dispatched but not reconciled.
`Failed`	Billing or charge failed for this merchant.

resultStatus required

MerchantBillingRunResultStatus MerchantBillingRunResultStatus

The raw per-merchant run-result status. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Success`	Merchant rated successfully. Terminal for a dry run; on a non-dry run it is a transient pre-dispatch state that the fulfillment dispatcher advances to a path-specific status (Invoiced or ChargePending).
`Failed`	Billing failed for this merchant.
`Skipped`	Merchant was skipped (e.g., inactive or excluded).
`NoPlan`	No active price plan assigned to this merchant.
`NoUsage`	No usage recorded for this merchant in the billing period.
`NoFulfillmentPath`	Neither ResellerBillingPreferences.DefaultFulfillmentPath nor the per-merchant MerchantBillingAssignment.FulfillmentPath override is set, so the resolver cannot decide how to collect payment for this merchant.
`NoPaymentMethod`	The effective fulfillment path is RecurringContract but no active MerchantBillingPaymentMethod row exists for the (ResellerId, MerchantId) pair, so the recurring charge has no token to draft against.
`MissingCollectionMerchant`	The effective fulfillment path is RecurringContract but the reseller has not configured a CollectionMerchantId, so there is no party to own the recurring contract.
`MissingHpp`	The effective fulfillment path is Invoicing but the reseller has not configured an HppPageId, so the generated invoice has no payment link destination.
`Invoiced`	The merchant was rated successfully and the Invoicing fulfillment path produced an issued invoice. Terminal for the Invoicing path: see MerchantBillingRunResult.InvoiceId for the artifact.
`Charged`	The RecurringContract path charge completed successfully. Set when the downstream charge reconciliation (tracked separately) confirms an approved transaction; see MerchantBillingRunResult.TransactionId.
`ChargePending`	The merchant was rated successfully and the RecurringContract path dispatched a charge request into the Transaction Manager. The charge has not yet been reconciled; the run records this as a non-terminal "awaiting result" state. See MerchantBillingRunResult.ContractId.
`ChargeFailed`	The RecurringContract path charge was attempted but declined or errored. Set by the downstream charge reconciliation (tracked separately).
`NoBillableUsage`	Usage was recorded for the merchant in the billing period, but the plan produced no positive-charge line item, so there is nothing to bill. Distinct from NoUsage (which means no usage aggregates existed at all): here the merchant genuinely transacted, the usage simply fell entirely within a rate entry's included/free allowance or matched no billable rate entry. Where a rate entry matched the usage, the rated run keeps the zero-billable line item visible so the operator can see the usage and why it was not charged; usage that matched no rate entry produces no line item.

fulfillmentPath required

BillingFulfillmentPath BillingFulfillmentPath

How the charge was (or would be) collected. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Invoicing`	Generate an invoice in PhoeniXGate.Invoicing addressed to the Merchant and route payment through the reseller's configured Hosted Payment Page.
`RecurringContract`	Charge a stored payment method (card or ACH) against the Merchant on a schedule, via a recurring contract owned by the reseller's collection merchant.

billingRunId required

string (uuid)

The billing run this row came from (links to the run detail page).

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

invoiceId required

string (uuid)

Generated invoice, when the Invoicing path produced one. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

runCompletedAt required

string (date-time)

When the billing run completed. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

This model has no documented fields.