For the complete documentation index, see llms.txt. This page is also available as Markdown.

Offer Status

An Offer and individual Products within an Offer can transition between several different statuses. Below is a state diagram of these transitions and their conditions.

The Offer API operates with a set number of states that an Offer can rest in. RECEIVED: The initial creation state for an Offer. This is not a live policy and requires confirmation to proceed. CONFIRMED: A successful and active Booking (or confirmed Offer). This is a live, paid-for policy that may be active or expired. This may be cancellable or modifiable, and can be claimed against.

CANCELLED: A Booking or confirmed Offer that has been formally cancelled. It cannot be claimed against, or modified. DELETED: A rare, final state indicating the Offer or Booking record has been removed (e.g., purged for data retention).

PENDING_PAYMENT: An Offer that has been accepted but requires final payment confirmation before transitioning to CONFIRMED. Only relevant for Offers that are confirmed using the require_payment_confirmation flag during a confirm offer request (usually followed by the confirm booking request) end state if confirmed will be CONFIRMED. FAILED: An Offer or Booking attempt that could not be completed due to a payment failure, system refusal, or technical error. RENEWED: A state used to depict a prior Booking that has been successfully renewed (e.g., after an annual renewal payment is confirmed).

Last updated

Was this helpful?