Reads a reseller's billing preferences.
POST
/api/resellers/get-billing-preferences-async
deprecated
Requires: Resellers.Resellers.Update, reseller scope.
Available to an administrator, to a reseller reading its own record, and to a reseller reading one it manages. Unlike the general read, this reaches the caller's own reseller record, which the ordinary reseller listing does not return. Returns `null` when the reseller has no billing preferences yet.
Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.
Example request
Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.
The request body is a . See the Request body section below for its fields.
Parameters
Request body
application/json
, required
| Field | Type | Description |
|---|
This request body has no documented fields.
Responses
200 OK
Body:
ResellerBillingPreferences
ResellerBillingPreferences
Each item has these 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 response has no documented body fields.
403 Forbidden
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
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 response has no documented body fields.
401 Unauthorized
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
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 response has no documented body fields.
400 Bad Request
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
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 response has no documented body fields.
404 Not Found
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
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 response has no documented body fields.
501 Not Implemented
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
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 response has no documented body fields.
500 Internal Server Error
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
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 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. The error reference lists the values `error.code` can take. 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. The error reference lists the values `error.code` can take.
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
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 response has no documented body fields.
429 The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
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 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.