core-lightning/doc/schemas/lightning-delinvoice.json

{
  "$schema": "../rpc-schema-draft.json",
  "type": "object",
  "additionalProperties": false,
  "rpc": "delinvoice",
  "title": "Command for removing an invoice (or just its description)",
  "description": [
    "The **delinvoice** RPC command removes an invoice with *status* as given in **listinvoices**, or with *desconly* set, removes its description."
  ],
  "request": {
    "required": [
      "label",
      "status"
    ],
    "properties": {
      "label": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "u64"
          }
        ],
        "description": [
          "Label of the invoice to be deleted."
        ]
      },
      "status": {
        "type": "string",
        "description": [
          "Label of the invoice to be deleted. The caller should be particularly aware of the error case caused by the *status* changing just before this command is invoked!"
        ],
        "enum": [
          "paid",
          "expired",
          "unpaid"
        ]
      },
      "desconly": {
        "type": "boolean",
        "description": [
          "If set to True, the invoice is not deleted, but has its description removed (this can save space with very large descriptions, as would be used with lightning-invoice(7) *deschashonly*."
        ]
      }
    }
  },
  "response": {
    "required": [
      "label",
      "payment_hash",
      "status",
      "created_index",
      "expires_at"
    ],
    "properties": {
      "label": {
        "type": "string",
        "description": [
          "Unique label given at creation time."
        ]
      },
      "bolt11": {
        "type": "string",
        "description": [
          "BOLT11 string."
        ]
      },
      "bolt12": {
        "type": "string",
        "description": [
          "BOLT12 string."
        ]
      },
      "amount_msat": {
        "type": "msat",
        "description": [
          "The amount required to pay this invoice."
        ]
      },
      "description": {
        "type": "string",
        "description": [
          "Description used in the invoice."
        ]
      },
      "payment_hash": {
        "type": "hash",
        "description": [
          "The hash of the *payment_preimage* which will prove payment."
        ]
      },
      "created_index": {
        "type": "u64",
        "added": "v23.08",
        "description": [
          "1-based index indicating order this invoice was created in."
        ]
      },
      "updated_index": {
        "type": "u64",
        "added": "v23.08",
        "description": [
          "1-based index indicating order this invoice was changed (only present if it has changed since creation)."
        ]
      },
      "status": {
        "type": "string",
        "description": [
          "State of invoice."
        ],
        "enum": [
          "paid",
          "expired",
          "unpaid"
        ]
      },
      "expires_at": {
        "type": "u64",
        "description": [
          "UNIX timestamp when invoice expires (or expired)."
        ]
      }
    },
    "allOf": [
      {
        "if": {
          "required": [
            "bolt12"
          ]
        },
        "then": {
          "required": [],
          "additionalProperties": false,
          "properties": {
            "label": {},
            "bolt12": {},
            "status": {},
            "expires_at": {},
            "msatoshi": {},
            "amount_msat": {},
            "description": {},
            "payment_hash": {},
            "pay_index": {},
            "created_index": {},
            "updated_index": {},
            "amount_received_msat": {},
            "paid_at": {},
            "payment_preimage": {},
            "local_offer_id": {
              "type": "hex",
              "description": [
                "Offer for which this invoice was created."
              ]
            },
            "invreq_payer_note": {
              "type": "string",
              "description": [
                "The optional *invreq_payer_note* from invoice_request which created this invoice."
              ]
            }
          }
        },
        "else": {
          "required": [
            "bolt11"
          ],
          "additionalProperties": false,
          "properties": {
            "label": {},
            "bolt11": {},
            "status": {},
            "expires_at": {},
            "msatoshi": {},
            "amount_msat": {},
            "description": {},
            "payment_hash": {},
            "pay_index": {},
            "created_index": {},
            "updated_index": {},
            "amount_received_msat": {},
            "msatoshi_received": {},
            "paid_at": {},
            "payment_preimage": {}
          }
        }
      },
      {
        "if": {
          "properties": {
            "status": {
              "type": "string",
              "enum": [
                "paid"
              ]
            }
          }
        },
        "then": {
          "additionalProperties": false,
          "required": [
            "pay_index",
            "amount_received_msat",
            "paid_at",
            "payment_preimage"
          ],
          "properties": {
            "label": {},
            "bolt11": {},
            "bolt12": {},
            "status": {},
            "expires_at": {},
            "msatoshi": {},
            "amount_msat": {},
            "description": {},
            "payment_hash": {},
            "invreq_payer_note": {},
            "local_offer_id": {},
            "created_index": {},
            "updated_index": {},
            "pay_index": {
              "type": "u64",
              "description": [
                "Unique index for this invoice payment."
              ]
            },
            "amount_received_msat": {
              "type": "msat",
              "description": [
                "How much was actually received."
              ]
            },
            "paid_at": {
              "type": "u64",
              "description": [
                "UNIX timestamp of when payment was received."
              ]
            },
            "payment_preimage": {
              "type": "secret",
              "description": [
                "SHA256 of this is the *payment_hash* offered in the invoice."
              ]
            }
          }
        },
        "else": {
          "additionalProperties": false,
          "properties": {
            "label": {},
            "bolt11": {},
            "bolt12": {},
            "status": {},
            "msatoshi": {},
            "amount_msat": {},
            "description": {},
            "payment_hash": {},
            "expires_at": {},
            "created_index": {},
            "updated_index": {},
            "pay_index": {},
            "invreq_payer_note": {},
            "local_offer_id": {}
          }
        }
      }
    ],
    "pre_return_value_notes": [
      "Note: The return is the same as an object from lightning-listinvoices(7)."
    ]
  },
  "errors": [
    "The following errors may be reported:",
    "",
    "- -1: Database error.",
    "- 905: An invoice with that label does not exist.",
    "- 906: The invoice *status* does not match the parameter. An error object will be returned as error *data*, containing *current_status* and *expected_status* fields. This is most likely due to the *status* of the invoice changing just before this command is invoked.",
    "- 908: The invoice already has no description, and *desconly* was set."
  ],
  "author": [
    "Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
  ],
  "see_also": [
    "lightning-listinvoices(7)",
    "lightning-waitinvoice(7)",
    "lightning-invoice(7)",
    "lightning-autoclean-status(7)"
  ],
  "resources": [
    "Main web site: <https://github.com/ElementsProject/lightning>"
  ],
  "examples": [
    {
      "request": {
        "id": "example:delinvoice#1",
        "method": "delinvoice",
        "params": {
          "label": "lbl_l36",
          "status": "unpaid"
        }
      },
      "response": {
        "label": "lbl_l36",
        "bolt11": "lnbcrt500u1pn2s3fwsp5e6nltgzk3yqn5033r6z2q32pzduys3zs5dtzc5cjs60ppcgytrsqpp5ykhhcxzcqeng2gfggmsdja3x8h0qmkl35lw9z7n99pfkg8w0s8asdqcdsenvgryv4ekxunfwp6xjmmwxqyjw5qcqp9rzjqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4jqqq0vqqqqgqqyqqqqqpqqqqqzsqqc9qxpqysgqwn7uwmy3x8u9c4ea0ka0yp3qvs0w9m7459g65kalm553vusctq8kseaph7tav4ryjfghnhu0ggjhhkrqmafarqkdsrzsk8stcvdmpmcqwfsajc",
        "payment_hash": "25af7c1858066685212846e0d976263dde0ddbf1a7dc517a652853641dcf81fb",
        "amount_msat": 50000000,
        "status": "unpaid",
        "description": "l36 description",
        "expires_at": 1722908590,
        "created_index": 9
      }
    },
    {
      "request": {
        "id": "example:delinvoice#2",
        "method": "delinvoice",
        "params": {
          "label": "lbl_l37",
          "status": "paid",
          "desconly": true
        }
      },
      "response": {
        "label": "lbl_l37",
        "bolt11": "lnbcrt500u1pn2s3fwsp5g96a3t3kn2we3ulrepd8eg4nw900wc324r06zlpr8py7p4zyftrspp5ggs9vzev5gcgthdysjrk0pcjgl3r5fwy4zgw6m48kk9nwx4h9slqdqcdsenwgryv4ekxunfwp6xjmmwxqyjw5qcqp9rzjqgkjyd3q5dv6gllh77kygly9c3kfy0d9xwyjyxsq2nq3c83u5vw4jqqq0vqqqqgqqyqqqqqpqqqqqzsqqc9qxpqysgqwkmgxwugmtjvf9cu324h87x5ux3cwa6glefyfxvergy3mw8gwtnzg05mrf69yz0dafk4n7u7asaxh2nx5jsylwvqttzxmr9krpc9rlsquhqkt4",
        "payment_hash": "4220560b2ca23085dda4848767871247e23a25c4a890ed6ea7b58b371ab72c3e",
        "amount_msat": 50000000,
        "status": "paid",
        "pay_index": 9,
        "amount_received_msat": 50000000,
        "paid_at": 1722303802,
        "payment_preimage": "e876ca5ae4ed9897178b2b3a17997256ad669335eb9201e05e3c97ffb83c634b",
        "expires_at": 1722908590,
        "created_index": 10,
        "updated_index": 9
      }
    }
  ]
}