LIGHTNING-DISABLEINVOICEREQUEST(7)

📦
version 26.06.9 · 2 versions
, in nixpkgs unstable

💅 LIGHTNING-DISABLEINVOICEREQUEST(7) — the manual page, but make it group chat

okay so bestie, this is the manual page for lightning-disableinvoicerequest (that's the manual name, iykyk) and it's literally about putting an invoice request to sleep 😴✨

✨ NAME ✨

disableinvoicerequest — the command for removing an invoice request 🎀

🦋 SYNOPSIS 🦋

disableinvoicerequest invreq_id

💖 DESCRIPTION 💖

So this command was added in v22.11 — vintage, iconic, periodt. ✨

The disableinvoicerequest RPC command disables an invoice_request, so that no further invoices will be accepted (and thus, no further payments made). it's giving "we're closed, go home" energy 💅

real talk though: we currently don't support deletion of invoice_requests, so they are not forgotten entirely (there may be payments which refer to this invoice_request). no cap, they stick around. 👀
  • invreq_id (string): you can disable one specific invoice by providing the invreq_id, which is presented by lightning-invoicerequest(7). that's your golden ticket 🎟️

👑 RETURN VALUE 👑

Note: the returned object is the same format as listinvoicerequests. On success, an object is returned, containing:

  • invreq_id (hash): the SHA256 hash of all invoice_request fields less than 160. math girlie behaviour fr fr 🧮
  • active (boolean) (always false): whether the invoice_request is currently active. it's always false here — that's literally the whole point bestie 😭
  • single_use (boolean): whether the invoice_request will become inactive after we pay an invoice for it.
  • bolt12 (string): the bolt12 string starting with lnr. 🦋
  • used (boolean): whether the invoice_request has already been used.
  • label (string, optional): the label provided when creating the invoice_request. 🏷️

🌸 AUTHOR 🌸

Rusty Russell rusty@rustcorp.com.au is mainly responsible. king behaviour, honestly 👑🫶

🌈 SEE ALSO 🌈

⭐ RESOURCES ⭐

Main web site: https://github.com/ElementsProject/lightning 🔥

🍓 EXAMPLES 🍓

Example 1:

Request:

$ lightning-cli disableinvoicerequest -k "invreq_id"="invreqid02020202020202020202020202020202020202020202020202020202"

{
  "id": "example:disableinvoicerequest#1",
  "method": "disableinvoicerequest",
  "params": {
    "invreq_id": "invreqid02020202020202020202020202020202020202020202020202020202"
  }
}

Response:

{
  "invreq_id": "invreqid02020202020202020202020202020202020202020202020202020202",
  "active": false,
  "single_use": true,
  "bolt12": "lno1qgsq000bolt240002400024000240002400024000240002400024000240002400024000240002400024000240002400024000240002400024000240002400024000240002400024000",
  "used": false
}

see how active came back false? that's the slay. that's the whole vibe check passing 💅✨

and that's a wrap, bestie! this page is from Core Lightning v26.06.9, the LIGHTNING-DISABLEINVOICEREQUEST(7) manual — go disable some invoice requests, drink water, and stan Rusty 💜🧚

📦 where this page comes from