ResellerBillingPreferences
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Per-reseller billing configuration embedded on the Reseller aggregate root. Controls billing run scheduling, payment terms, and invoice generation preferences.
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 | ||||
|---|---|---|---|---|---|---|
defaultPaymentTerms
required |
integer (int32) | Days until invoice due date (e.g. 30).
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.
| ||||
defaultCurrency
required |
string | ISO 4217 default currency for billing.
nullablemin length 0max length 3
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.
| ||||
hppPageId
required |
string (uuid) | HPP page ID used for invoice payment links.
Required: When DefaultFulfillmentPath == Invoicing and AllowOnlinePayment is true.
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.
| ||||
captureHppPageId
required |
string (uuid) | HPP page ID used to capture and store a card on file for the recurring-contract billing
path (the operator-driven payment-method capture flow). This must reference a
`SaveCard`-purpose page (zero-dollar verification, no charge) so capture does not
prompt the operator for an amount. Distinct from `hppPageId`, which is the
Invoicing payment-link page (a chargeable `Payment` page).
Required: When DefaultFulfillmentPath == RecurringContract.
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.
| ||||
allowOnlinePayment
required |
boolean | Whether merchants can pay invoices online via HPP.
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.
| ||||
allowStoredPaymentMethods
required |
boolean | Whether merchants can store payment methods for billing.
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.
| ||||
autoChargeStoredMethod
required |
boolean | Auto-charge stored payment method after invoice generation.
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.
| ||||
autoBillingEnabled
required |
boolean | Whether automated billing runs are enabled.
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.
| ||||
billingPeriod
required |
integer (int32) | Billing period: 1=Monthly, 3=Quarterly.
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.
| ||||
billingDayOfMonth
required |
integer (int32) | Day of month for billing runs (1-28).
nullablemin 1max 28
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.
| ||||
invoiceTemplateId
required |
string (uuid) | Invoice template ID (Phase 2: Invoicing module).
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.
| ||||
defaultTaxRateId
required |
string (uuid) | Default tax rate ID (Phase 2: Invoicing module).
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.
| ||||
sendInvoiceOnGeneration
required |
boolean | Auto-send invoice to merchant after generation.
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.
| ||||
billingRunNotificationEmail
required |
string | Admin notification email for billing run completions.
nullablemin length 0max length 256
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.
| ||||
defaultFulfillmentPath
required |
BillingFulfillmentPath BillingFulfillmentPath | Default fulfillment path for billing runs under this reseller. When null and a merchant
has no per-assignment override, the merchant is skipped with result status
`NoFulfillmentPath`.
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.
| ||||
collectionMerchantId
required |
string (uuid) | The reseller-owned billing entity that owns recurring contracts and vaults stored
payment methods. Required when `defaultFulfillmentPath` is
`RecurringContract`. This may be the reseller itself
or a designated child merchant; modeled internally as a single "MLB collection party"
reference so the legacy House Merchant flag is not reintroduced.
Required: When DefaultFulfillmentPath == RecurringContract.
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.
| ||||
allowCardPayments
required |
boolean | Whether card tokens are permitted as stored payment methods for billed merchants.
Treated as `true` by callers when null on legacy documents.
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.
| ||||
allowAchPayments
required |
boolean | Whether ACH tokens are permitted as stored payment methods for billed merchants.
Treated as `true` by callers when null on legacy documents, matching
`allowCardPayments`: both are read permissively, rejecting only an explicit
`false`.
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.