MerchantBillingAssignment
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Per-merchant billing assignment embedded on the Merchant aggregate root. Replaces the standalone MerchantPricePlanAssignment container; a merchant has at most one active price plan at a time, so the assignment behaves as a single-row property rather than a separate aggregate. Lookup is a point-read on the merchant; the platform never needs cross-time assignment history (audit log captures changes).
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 | ||||
|---|---|---|---|---|---|---|
pricePlanId
required |
string (uuid) | The price plan currently assigned to this merchant. Null means the merchant has
no active billing plan and will be skipped by billing runs.
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.
| ||||
effectiveFrom
required |
string (date-time) | Optional start date for the assignment. Billing runs prior to this date will skip
the merchant. Null means effective immediately on assign.
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.
| ||||
effectiveTo
required |
string (date-time) | Optional end date for the assignment. Billing runs after this date will skip the
merchant. Null means open-ended.
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.
| ||||
fulfillmentPath
required |
BillingFulfillmentPath BillingFulfillmentPath | Optional per-merchant override of the fulfillment path. When null the resolver
inherits `defaultFulfillmentPath`.
Only the path itself is overridable: collection plumbing (HPP id, collection
merchant, payment-method allowlist) is reseller-level only and is never re-picked
per assignment. This is a deliberate scope call to avoid re-introducing the legacy
House Merchant per-assignment friction.
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.