LIGHTNING-DISABLEOFFER(7)

💅 LIGHTNING-DISABLEOFFER(7) — the "okay bestie, this offer is CLOSED" page

Bestie. Welcome to lightning-disableoffer, section 7 of the manual. This is the page where we learn how to take an offer out back and gently retire it. Grab a snack. 🍓

---

✨ NAME ✨

disableoffer — the command for removing an offer. Like, not deleting deleting, but making it stop doing its little job. It's giving "retired but still on the org chart." 💀

---

🌸 SYNOPSIS 🌸

disableoffer offer_id

---

🎀 DESCRIPTION 🎀

The disableoffer RPC command disables an offer, so that no further invoices will be given out. Periodt. Once it's disabled, that offer is not out here handing out invoices to anyone, no cap. 🚫🧾

Okay but here's the important little caveat, and I need you to hear me: we currently don't support deletion of offers, so offers are not forgotten entirely (there may be invoices which refer to this offer). So like, it's disabled, not erased. It still exists in the system's memory, lurking, being referenced by invoices. Main character who refuses to leave the group chat. 😭

• offer_id (hash): The id we use to identify this offer. That's the one you pass in.

---

👑 RETURN VALUE 👑

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

• offer_id (hash): The merkle hash of the offer.
• active (boolean) (always false): Whether the offer can produce invoices/payments. It's always false here, bestie — that's literally the whole point of the command, that's the slay. 💅
• single_use (boolean): Whether the offer is disabled after first successful use.
• force_paths (boolean): True if fronting_nodes (or the payment-fronting-node configuration entry) is set: implies any invoice issued for this offer must use a subset of the same blinded paths. (added v26.04) 🔥
• bolt12 (string): The bolt12 string representing this offer.
• used (boolean): Whether the offer has had an invoice paid / payment made.
• description (string, optional): The user-specified bolt 12 description. (added v26.04) ✨
• label (string, optional): The label provided when offer was created.

---

🦋 AUTHOR 🦋

Rusty Russell rusty@rustcorp.com.au is mainly responsible. Iconic behavior, honestly. 🫶

---

🌈 SEE ALSO 🌈

• lightning-enableoffer(7) — the undo button, the comeback arc
• lightning-offer(7) — where offers come from
• lightning-listoffers(7) — where you go to see all of them

---

⭐ RESOURCES ⭐

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

---

🧚 EXAMPLES 🧚

Okay so here's Example 1, let me walk you through it. 🚶‍♀️

Request:

$ lightning-cli disableoffer -k "offer_id"="offeridl23000002300000230000023000002300000230000023000002300000"

{
  "id": "example:disableoffer#1",
  "method": "disableoffer",
  "params": {
    "offer_id": "offeridl23000002300000230000023000002300000230000023000002300000"
  }
}

Response:

{
  "offer_id": "offeridl23000002300000230000023000002300000230000023000002300000",
  "active": false,
  "single_use": false,
  "bolt12": "lno1qgsq000bolt230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000",
  "description": "Movie ticket",
  "used": false
}

See that "active": false? Yeah. That's the vibe check passing. 🎟️💀

---

So that's the whole page, bestie — go forth and disable responsibly. This little number comes to you from Core Lightning v26.06.9, dated the day LIGHTNING-DISABLEOFFER(7) got its glow-up. Mwah. 💖🎀🌸