OrderAdditionEligibility

Part of the response of GET /orders/{orderId}/addition-requests and GET /orders/{orderId}/addition-offers.

Type: object

Example

Schema example: from the GET /orders/{orderId}/addition-requests response

{
  "eligible": true,
  "reasons": []
}

eligible boolean required: Example true
reasons array of string required: EVERY reason this order cannot carry an addition, not just the first, so a client can say all of it at once. feature_disabled: additions are not open in this environment yet. guest_order: the order has no signed-in buyer, so nobody can approve a later payment. handoff_checkout: the checkout happened on the seller’s own store, so Snapcaster never captured the original payment. platform_incompatible: the seller fulfils through a connected platform whose contract has not yet been shown to consume additions correctly. order_not_active: the order has shipped, been delivered, been fully cancelled or been refunded - additional cards need a new order (a PARTIALLY cancelled order is still active and still eligible). terms_missing: the payment that captured the order cannot state its frozen fee terms, so an addition has nothing to be priced from. Empty when eligible is true.
Field example
[]