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:52 UTC.

`BillingRunEnvironmentCoverageDto`

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

How many of a reseller's assigned merchants a billing run would bill for usage their price plan does not price. A merchant's transactions meter into the production or the sandbox SKU family by its environment, and a plan prices each family explicitly, so a Sandbox merchant on a plan with no sandbox rate entries is billed custom items only. Counts only: no merchant or plan is named.

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

assignedMerchantCount required

integer (int32)

Merchants a run for the period would bill: active, assigned a price plan, with an assignment window that overlaps the period. The reseller's collection merchant is not counted.

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.

unpricedSandboxMerchantCount required

integer (int32)

Assigned merchants that meter into the sandbox SKU family (every environment except Production) whose plan has no enabled sandbox rate entry.

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.

unpricedProductionMerchantCount required

integer (int32)

Assigned merchants in the Production environment whose plan has no enabled production rate entry.

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 model has no documented fields.