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-22 22:57 UTC.
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
One catalog product a hosted payment page sells. References an invoicing catalog product by id
and carries the page's own presentation decisions for it: where it sits, whether the payer may
leave it out, whether they may change the quantity, and what quantity the page starts at.
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
productIdrequired
string (uuid)
The invoicing catalog product this entry sells.
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.
displayOrderrequired
integer (int32)
Zero-based position of the product in the payer-facing list.min 0
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.
isOptionalrequired
boolean
`true` for an add-on the payer may leave out; `false` for a product every purchase
on this page includes.
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.
allowQuantityChangerequired
boolean
Whether the payer may change the quantity from `defaultQuantity`.
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.
defaultQuantityrequired
number (double)
The quantity the page starts at. Must sit inside the effective quantity bounds, and is the
only quantity a payer can buy when `allowQuantityChange` is `false`.
Conditional: When MinimumQuantity is not null. Must be >= .
Conditional: When MaximumQuantity is not null. Must be <= .greater than 0max 9999
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.
minimumQuantityrequired
number (double)
Optional page-level floor on the quantity, applied on top of the product's own
`MinimumQuantity`. The effective minimum is the larger of the two.
Conditional: When MinimumQuantity is not null. Must be > 0.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.
maximumQuantityrequired
number (double)
Optional page-level ceiling on the quantity, applied on top of the product's own
`MaximumQuantity`. The effective maximum is the smaller of the two.
Conditional: When MaximumQuantity is not null. Must be > 0.
Conditional: When MinimumQuantity is not null and MaximumQuantity is not null. Must be >= .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.
Reconnecting to the server
Could not reconnect
This session has ended
Attempt 1
Your work on this page is still here. Retrying keeps it; reloading starts the page again.
The server no longer holds this page's state, so it has to be loaded again.