core-lightning/doc/schemas/offer.schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "offer_id",
    "active",
    "single_use",
    "bolt12",
    "used",
    "created"
  ],
  "properties": {
    "offer_id": {
      "type": "hash",
      "description": "the id of this offer (merkle hash of non-signature fields)"
    },
    "active": {
      "type": "boolean",
      "enum": [
        true
      ],
      "description": "whether this can still be used"
    },
    "single_use": {
      "type": "boolean",
      "description": "whether this expires as soon as it's paid (reflects the *single_use* parameter)"
    },
    "bolt12": {
      "type": "string",
      "description": "the bolt12 encoding of the offer"
    },
    "used": {
      "type": "boolean",
      "description": "True if an associated invoice has been paid"
    },
    "created": {
      "type": "boolean",
      "description": "false if the offer already existed"
    },
    "label": {
      "type": "string",
      "description": "the (optional) user-specified label"
    }
  }
}