> ## Documentation Index
> Fetch the complete documentation index at: https://uqp.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# UQP reusable definitions

> Reuse pack identifiers, currency amounts, consent, sessions and checkout handoff definitions across UQP objects.

Source: spec/schemas/common.json. Draft v0.1; reference, not production.

Use the canonical JSON below for all constraints.

## Properties and definitions

| Property / definition | Required | Type / reference | Description / constraints |
| - | - | - | - |
| identifier | definition | string | \{"type":"string","minLength":1} |
| consent | definition | object | \{"type":"object","properties":\{"share\_for\_pricing\_research":\{"type":"boolean"},"anonymize":\{"type":"boolean"},"captured\_at":\{"type":"string","format":"date-time"}},"required":\["share\_for\_pricing\_research","anonymize","captured\_at"],"additionalProperties":false} |
| answers | definition | object | \{"type":"object","propertyNames":\{"not":\{"enum":\["email","phone","name","first\_name","last\_name","full\_name","address","contact","contact\_details","date\_of\_birth"]}},"additionalProperties":true} |
| currencies | definition | array | \{"type":"array","items":\{"type":"string","pattern":"^\[A-Z]\{3}\$"},"minItems":1,"uniqueItems":true} |
| reviewMode | definition | enum | \{"enum":\["pre\_price","post\_price"]} |
| expiryDays | definition | integer | \{"type":"integer","minimum":1} |
| packId | definition | string | \{"type":"string","minLength":1} |
| packVersion | definition | string | \{"type":"string","minLength":1} |
| priceRange | definition | object | \{"type":"object","properties":\{"min":\{"type":"number","minimum":0},"max":\{"type":"number","minimum":0},"currency":\{"type":"string","pattern":"^\[A-Z]\{3}\$"},"basis":\{"enum":\["hourly","day\_rate","from","fixed"]},"method":\{"enum":\["artist\_stated","rule","logged\_quotes"]},"n":\{"type":"integer","minimum":5},"provenance":\{"\$ref":"#/\$defs/provenance"},"min\_minor":\{"type":"integer","minimum":0,"maximum":9007199254740991},"max\_minor":\{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":\["min","max","currency","basis","method","provenance"],"additionalProperties":false,"allOf":\[\{"if":\{"properties":\{"method":\{"const":"logged\_quotes"}},"required":\["method"]},"then":\{"required":\["n"],"properties":\{"n":\{}}}}]} |
| deposit | definition | object | Provider is merchant of record; UQP never holds funds. Only processor confirmation marks a deposit paid. |
| clientApproval | definition | object | \{"type":"object","properties":\{"amount":\{"type":"number","minimum":0},"currency":\{"type":"string","pattern":"^\[A-Z]\{3}\$"},"policies":\{"type":"array","minItems":1,"items":\{"type":"string","minLength":1}},"approved\_amount":\{"const":true},"approved\_policies":\{"const":true},"approved\_at":\{"type":"string","format":"date-time"},"amount\_minor":\{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":\["amount","currency","policies","approved\_amount","approved\_policies","approved\_at"],"additionalProperties":false} |
| provenance | definition | object | \{"type":"object","properties":\{"who":\{"type":"string","minLength":1},"when":\{"type":"string","format":"date-time"}},"required":\["who","when"],"additionalProperties":false} |
| quantity | definition | integer | \{"type":"integer","minimum":1,"maximum":9007199254740991} |
| quantityUnit | definition | object | Rec 20 unit descriptor. Quantity counts steps of 10^-scale units; omitted scale means zero. |
| attribution | definition | object | Neutral routing attribution; not payment authorization or proof of consent. |
| routingPolicy | definition | object | \{"type":"object","properties":\{"allow\_stateless\_estimate":\{"type":"boolean"},"require\_human\_quote\_review":\{"type":"boolean"},"max\_concurrent\_quote\_holds":\{"type":"integer","minimum":1}},"additionalProperties":false} |
| checkoutHandoff | definition | object | Reference handoff metadata, not payment execution. Draft proposal mappings are subject to change; no conformance claim. |

## Full JSON

```json theme={null}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://uqp.dev/spec/schemas/common.json",
  "title": "UQP reusable definitions",
  "$defs": {
    "identifier": {
      "type": "string",
      "minLength": 1
    },
    "consent": {
      "type": "object",
      "properties": {
        "share_for_pricing_research": {
          "type": "boolean"
        },
        "anonymize": {
          "type": "boolean"
        },
        "captured_at": {
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "share_for_pricing_research",
        "anonymize",
        "captured_at"
      ],
      "additionalProperties": false
    },
    "answers": {
      "type": "object",
      "propertyNames": {
        "not": {
          "enum": [
            "email",
            "phone",
            "name",
            "first_name",
            "last_name",
            "full_name",
            "address",
            "contact",
            "contact_details",
            "date_of_birth"
          ]
        }
      },
      "additionalProperties": true
    },
    "currencies": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Z]{3}$"
      },
      "minItems": 1,
      "uniqueItems": true
    },
    "reviewMode": {
      "enum": [
        "pre_price",
        "post_price"
      ]
    },
    "expiryDays": {
      "type": "integer",
      "minimum": 1
    },
    "packId": {
      "type": "string",
      "minLength": 1
    },
    "packVersion": {
      "type": "string",
      "minLength": 1
    },
    "priceRange": {
      "type": "object",
      "properties": {
        "min": {
          "type": "number",
          "minimum": 0
        },
        "max": {
          "type": "number",
          "minimum": 0
        },
        "currency": {
          "type": "string",
          "pattern": "^[A-Z]{3}$"
        },
        "basis": {
          "enum": [
            "hourly",
            "day_rate",
            "from",
            "fixed"
          ]
        },
        "method": {
          "enum": [
            "artist_stated",
            "rule",
            "logged_quotes"
          ]
        },
        "n": {
          "type": "integer",
          "minimum": 5
        },
        "provenance": {
          "$ref": "#/$defs/provenance"
        },
        "min_minor": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "max_minor": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "min",
        "max",
        "currency",
        "basis",
        "method",
        "provenance"
      ],
      "additionalProperties": false,
      "allOf": [
        {
          "if": {
            "properties": {
              "method": {
                "const": "logged_quotes"
              }
            },
            "required": [
              "method"
            ]
          },
          "then": {
            "required": [
              "n"
            ],
            "properties": {
              "n": {}
            }
          }
        }
      ]
    },
    "deposit": {
      "type": "object",
      "description": "Provider is merchant of record; UQP never holds funds. Only processor confirmation marks a deposit paid.",
      "properties": {
        "amount": {
          "type": "number",
          "minimum": 0
        },
        "basis": {
          "type": "string",
          "minLength": 1
        },
        "policies": {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "string",
            "minLength": 1
          }
        },
        "status": {
          "enum": [
            "unpaid",
            "paid"
          ]
        },
        "merchant_of_record": {
          "const": "provider"
        },
        "confirmation": {
          "type": "object",
          "properties": {
            "source": {
              "const": "payment_processor"
            },
            "reference": {
              "type": "string",
              "minLength": 1
            },
            "confirmed_at": {
              "type": "string",
              "format": "date-time"
            }
          },
          "required": [
            "source",
            "reference",
            "confirmed_at"
          ],
          "additionalProperties": false
        },
        "provenance": {
          "$ref": "#/$defs/provenance"
        },
        "amount_minor": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "capture_on": {
          "enum": [
            "accept",
            "booking",
            "immediate"
          ]
        },
        "refundable_until": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "policy_url": {
          "type": "string",
          "format": "uri"
        }
      },
      "required": [
        "amount",
        "basis",
        "policies",
        "status",
        "merchant_of_record",
        "provenance"
      ],
      "additionalProperties": false,
      "allOf": [
        {
          "if": {
            "properties": {
              "status": {
                "const": "paid"
              }
            },
            "required": [
              "status"
            ]
          },
          "then": {
            "required": [
              "confirmation"
            ],
            "properties": {
              "confirmation": {}
            }
          },
          "else": {
            "not": {
              "required": [
                "confirmation"
              ],
              "properties": {
                "confirmation": {}
              }
            }
          }
        }
      ]
    },
    "clientApproval": {
      "type": "object",
      "properties": {
        "amount": {
          "type": "number",
          "minimum": 0
        },
        "currency": {
          "type": "string",
          "pattern": "^[A-Z]{3}$"
        },
        "policies": {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "string",
            "minLength": 1
          }
        },
        "approved_amount": {
          "const": true
        },
        "approved_policies": {
          "const": true
        },
        "approved_at": {
          "type": "string",
          "format": "date-time"
        },
        "amount_minor": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "amount",
        "currency",
        "policies",
        "approved_amount",
        "approved_policies",
        "approved_at"
      ],
      "additionalProperties": false
    },
    "provenance": {
      "type": "object",
      "properties": {
        "who": {
          "type": "string",
          "minLength": 1
        },
        "when": {
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "who",
        "when"
      ],
      "additionalProperties": false
    },
    "quantity": {
      "type": "integer",
      "minimum": 1,
      "maximum": 9007199254740991
    },
    "quantityUnit": {
      "type": "object",
      "description": "Rec 20 unit descriptor. Quantity counts steps of 10^-scale units; omitted scale means zero.",
      "properties": {
        "unit": {
          "enum": [
            "C62",
            "INH",
            "CMT",
            "FTK",
            "MTK",
            "HUR",
            "MIN"
          ]
        },
        "scale": {
          "type": "integer",
          "minimum": 0,
          "maximum": 15,
          "default": 0
        },
        "display_text": {
          "type": "string"
        }
      },
      "required": [
        "unit",
        "display_text"
      ],
      "additionalProperties": false,
      "allOf": [
        {
          "if": {
            "properties": {
              "unit": {
                "const": "C62"
              }
            },
            "required": [
              "unit"
            ]
          },
          "then": {
            "properties": {
              "scale": {
                "const": 0
              }
            }
          }
        }
      ]
    },
    "attribution": {
      "type": "object",
      "description": "Neutral routing attribution; not payment authorization or proof of consent.",
      "properties": {
        "referrer_id": {
          "type": "string"
        },
        "token": {
          "type": "string"
        },
        "campaign": {
          "type": "string"
        },
        "source": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "routingPolicy": {
      "type": "object",
      "properties": {
        "allow_stateless_estimate": {
          "type": "boolean"
        },
        "require_human_quote_review": {
          "type": "boolean"
        },
        "max_concurrent_quote_holds": {
          "type": "integer",
          "minimum": 1
        }
      },
      "additionalProperties": false
    },
    "checkoutHandoff": {
      "type": "object",
      "description": "Reference handoff metadata, not payment execution. Draft proposal mappings are subject to change; no conformance claim.",
      "properties": {
        "protocol": {
          "enum": [
            "ucp",
            "acp"
          ]
        },
        "url": {
          "type": [
            "string",
            "null"
          ],
          "format": "uri"
        },
        "ucp_quote_status": {
          "enum": [
            "pending",
            "quoted",
            "accepted",
            "declined",
            "expired",
            "withdrawn"
          ]
        },
        "acp_quote_id": {
          "type": "string"
        },
        "quote_expires_at": {
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "protocol",
        "url"
      ],
      "additionalProperties": false
    }
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.