generated: '2026-09-28'
method: derived
generator: derive-data-model.py
source:
- openapi/_original/checkout-sdk.yml
notation: has_one = property $ref; has_many = array of $ref; belongs_to = <entity>_id field
summary:
  entities: 24
  entities_in_spec: 24
  relationships: 15
entities:
- name: CheckoutSession
  fields: 7
- name: CheckoutSessionCancelledEvent
  fields: 0
- name: CheckoutSessionCompletedEvent
  fields: 0
- name: CheckoutSessionEnvelope
  fields: 1
- name: CheckoutSessionExpiredEvent
  fields: 0
- name: CreatePaymentRequest
  fields: 4
  description: Shared request body for one-time payment sessions and headless
- name: DefaultPaymentMethodResponse
  fields: 1
- name: ErrorDetail
  fields: 4
- name: ErrorResponse
  fields: 1
  description: Error envelope returned on every non-`2xx` response. Branch on the
- name: ExternalLineItem
  fields: 6
- name: HeadlessPayment
  fields: 5
  description: Acknowledgement that a headless payment was accepted for processing.
- name: HeadlessPaymentEnvelope
  fields: 1
- name: HeadlessPaymentFailed
  fields: 5
- name: HeadlessPaymentOutcomeEnvelope
  fields: 1
- name: HeadlessPaymentSucceeded
  fields: 6
- name: IntegratorMetadata
  fields: 0
  description: Optional integrator-owned correlation values (up to 20 keys, string
- name: OrderAmounts
  fields: 2
- name: PaymentAmounts
  fields: 4
  description: Split of the order total between eligible Bilt credits and the
- name: PaymentFailedEvent
  fields: 0
- name: PaymentFailure
  fields: 3
  description: Why a headless charge could not be completed.
- name: PaymentMethodSummary
  fields: 5
- name: PaymentSucceededEvent
  fields: 0
- name: WebhookDataBase
  fields: 4
- name: WebhookEventBase
  fields: 2
relationships:
- from: CreatePaymentRequest
  to: ExternalLineItem
  type: has_many
  via: lineItems
- from: CreatePaymentRequest
  to: IntegratorMetadata
  type: has_one
  via: metadata
- from: CheckoutSessionEnvelope
  to: CheckoutSession
  type: has_one
  via: data
- from: CheckoutSession
  to: OrderAmounts
  type: has_one
  via: amounts
- from: HeadlessPaymentEnvelope
  to: HeadlessPayment
  type: has_one
  via: data
- from: HeadlessPayment
  to: PaymentAmounts
  type: has_one
  via: amounts
- from: HeadlessPaymentSucceeded
  to: PaymentAmounts
  type: has_one
  via: amounts
- from: HeadlessPaymentFailed
  to: PaymentFailure
  type: has_one
  via: failure
- from: WebhookDataBase
  to: IntegratorMetadata
  type: has_one
  via: metadata
- from: CheckoutSessionCompletedEvent
  to: WebhookDataBase
  type: has_one
  via: data
- from: CheckoutSessionCancelledEvent
  to: WebhookDataBase
  type: has_one
  via: data
- from: CheckoutSessionExpiredEvent
  to: WebhookDataBase
  type: has_one
  via: data
- from: PaymentSucceededEvent
  to: WebhookDataBase
  type: has_one
  via: data
- from: PaymentFailedEvent
  to: WebhookDataBase
  type: has_one
  via: data
- from: ErrorResponse
  to: ErrorDetail
  type: has_one
  via: error