Reads the billing preferences of the calling operator's own reseller.
POST
/api/resellers/get-own-billing-preferences-async
deprecated
Requires: Resellers.Resellers.Update, reseller scope.
The reseller is resolved from the signed-in user, so this route takes no reseller id and cannot be pointed at another reseller. A caller with no reseller of its own, an administrator for instance, is refused; use the id-taking read instead. Returns `null` when the reseller has no billing preferences yet.
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
| Name | In | Type | Description |
|---|---|---|---|
suppressNulls
required |
query | boolean | If true, omit properties with null values. |
Request body
application/json
, required
| Field | Type | Description |
|---|
This request body has no documented fields.
Responses
200 OK
Body: ResellerBillingPreferences
Each item has these fields.
| Field | Type | Description |
|---|---|---|
defaultPaymentTerms
required |
integer (int32) | Days until invoice due date (e.g. 30). nullable |
defaultCurrency
required |
string | ISO 4217 default currency for billing. nullablemin length 0max length 3 |
hppPageId
required |
string (uuid) | HPP page ID used for invoice payment links. Required: When DefaultFulfillmentPath == Invoicing and AllowOnlinePayment is true. nullable |
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 |
allowOnlinePayment
required |
boolean | Whether merchants can pay invoices online via HPP. nullable |
allowStoredPaymentMethods
required |
boolean | Whether merchants can store payment methods for billing. nullable |
autoChargeStoredMethod
required |
boolean | Auto-charge stored payment method after invoice generation. nullable |
autoBillingEnabled
required |
boolean | Whether automated billing runs are enabled. nullable |
billingPeriod
required |
integer (int32) | Billing period: 1=Monthly, 3=Quarterly. nullable |
billingDayOfMonth
required |
integer (int32) | Day of month for billing runs (1-28). nullablemin 1max 28 |
invoiceTemplateId
required |
string (uuid) | Invoice template ID (Phase 2: Invoicing module). nullable |
defaultTaxRateId
required |
string (uuid) | Default tax rate ID (Phase 2: Invoicing module). nullable |
sendInvoiceOnGeneration
required |
boolean | Auto-send invoice to merchant after generation. nullable |
billingRunNotificationEmail
required |
string | Admin notification email for billing run completions. nullablemin length 0max length 256 |
defaultFulfillmentPath
required |
all of 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 |
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 |
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 |
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 |
This response has no documented body fields.
403 Forbidden
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
401 Unauthorized
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
400 Bad Request
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
404 Not Found
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
501 Not Implemented
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
500 Internal Server Error
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
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. See the error-code reference in this document's description for the values `error.code` can take.
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
429 The request was refused because a rate limit was exceeded. 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.
Body: RateLimitProblemDetails
Each item has these fields.
| Field | Type | Description |
|---|---|---|
type
required |
string | The problem type identifier. Always the same value: the failure is the status code itself, so there is no sub-type for a caller to branch on. nullable |
title
required |
string | A short, human-readable summary of the problem type. nullable |
status
required |
integer (int32) | The HTTP status code, repeated in the body as the problem-details format defines. |
detail
required |
string | A human-readable explanation of this occurrence of the problem. nullable |
retryAfterSeconds
required |
integer (int32) | How long to wait before retrying, in whole seconds, carrying the same figure as the `Retry-After` header. Always at least one: a value of zero would invite an immediate retry that is certain to be rejected again. |
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.