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-23 00:19 UTC.

`CreateBillingRunInput`

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

Request body for starting a new billing run.

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

periodKey required

string

Billing period key in yyyyMM format (e.g., "202602" for February 2026). nullablemin length 0max length 10

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.

isDryRun required

boolean

When true, calculates charges without generating invoices (preview mode).

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.

resellerId required

string (uuid)

Optional reseller to run billing for. Omit it to run for the caller's own reseller (or, for an admin with no reseller selected, to bill every reseller). When set, the run bills that one reseller's merchants; a reseller caller may name their own reseller or any reseller beneath it, and an admin may name any reseller. A reseller outside the caller's scope is reported as not found. Not accepted by the all-resellers trigger. Conditional: When ResellerId is not null. 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 model has no documented fields.