UcpCheckout

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/adadiamonds-com/json-schema/adadiamonds-com-ucp-checkout-schema.json",
  "title": "UcpCheckout",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/adadiamonds-com-openapi.json#/components/schemas/UcpCheckout",
  "type": "object",
  "required": [
    "ucp",
    "id",
    "line_items",
    "status",
    "currency",
    "totals",
    "links"
  ],
  "properties": {
    "ucp": {
      "$ref": "#/$defs/UcpEnvelope"
    },
    "id": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "incomplete",
        "requires_escalation",
        "ready_for_complete",
        "complete_in_progress",
        "completed",
        "canceled"
      ]
    },
    "currency": {
      "type": "string",
      "enum": [
        "USD"
      ]
    },
    "expires_at": {
      "type": "string",
      "format": "date-time"
    },
    "continue_url": {
      "type": "string",
      "format": "uri"
    },
    "buyer": {
      "$ref": "#/$defs/UcpBuyer"
    },
    "line_items": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/UcpLineItem"
      }
    },
    "totals": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/UcpTotal"
      }
    },
    "messages": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/UcpMessage"
      }
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type",
          "url"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "privacy_policy",
              "terms_of_service",
              "refund_policy",
              "shipping_policy",
              "faq"
            ]
          },
          "url": {
            "type": "string",
            "format": "uri"
          }
        }
      }
    },
    "fulfillment": {
      "type": "object"
    },
    "payment": {
      "type": "object"
    },
    "order": {
      "$ref": "#/$defs/UcpOrder"
    }
  },
  "$defs": {
    "UcpBuyer": {
      "type": "object",
      "properties": {
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "email": {
          "type": "string",
          "format": "email"
        },
        "phone_number": {
          "type": "string"
        }
      }
    },
    "UcpEnvelope": {
      "type": "object",
      "required": [
        "version",
        "status"
      ],
      "properties": {
        "version": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": [
            "success",
            "error"
          ]
        },
        "capabilities": {
          "type": "object"
        },
        "payment_handlers": {
          "type": "object"
        }
      }
    },
    "UcpLineItem": {
      "type": "object",
      "required": [
        "id",
        "item",
        "quantity",
        "totals"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "item": {
          "type": "object",
          "required": [
            "id",
            "title",
            "price"
          ],
          "properties": {
            "id": {
              "type": "string"
            },
            "title": {
              "type": "string"
            },
            "price": {
              "type": "integer",
              "description": "Unit price. Integer minor units (cents)."
            },
            "image_url": {
              "type": "string",
              "format": "uri"
            }
          }
        },
        "quantity": {
          "type": "integer"
        },
        "totals": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/UcpTotal"
          }
        }
      }
    },
    "UcpMessage": {
      "type": "object",
      "required": [
        "type",
        "content"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "error",
            "warning",
            "info"
          ]
        },
        "code": {
          "type": "string",
          "description": "missing, out_of_stock, item_unavailable, payment_failed, eligibility_invalid, not_found, unauthorized, conflict, expired, idempotency_conflict, signature_invalid"
        },
        "content": {
          "type": "string"
        },
        "content_type": {
          "type": "string",
          "enum": [
            "plain",
            "markdown"
          ]
        },
        "severity": {
          "type": "string",
          "enum": [
            "recoverable",
            "requires_buyer_input",
            "requires_buyer_review",
            "unrecoverable"
          ]
        },
        "path": {
          "type": "string",
          "description": "RFC 9535 JSONPath"
        }
      }
    },
    "UcpOrder": {
      "type": "object",
      "required": [
        "id",
        "permalink_url"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "label": {
          "type": "string"
        },
        "permalink_url": {
          "type": "string",
          "format": "uri"
        }
      }
    },
    "UcpTotal": {
      "type": "object",
      "required": [
        "type",
        "amount"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "subtotal",
            "discount",
            "fulfillment",
            "tax",
            "fee",
            "total"
          ]
        },
        "amount": {
          "type": "integer",
          "description": "Amount. Integer minor units (cents)."
        }
      }
    }
  }
}