LIGHTNING-CANCELRECURRINGINVOICE(7)

📦
version 26.06.9 · 2 versions
, in nixpkgs unstable

💅 LIGHTNING-CANCELRECURRINGINVOICE(7) 💅

okay bestie, welcome to the lightning-cancelrecurringinvoice page — yes it's a whole mouthful, but it's giving "polite queen energy" and we're gonna get through it together 🫶

✨ NAME ✨

cancelrecurringinvoice — the command for sending a cancel message for a recurring offer 🎀

🌸 SYNOPSIS 🌸

cancelrecurringinvoice offer recurrence_counter recurrence_label [recurrence_start] [payer_note] [bip353]

🦋 DESCRIPTION 🦋

So this command was added in v25.09, ngl it's fresh ✨

💀 NOTE: Recurring offers are experimental, and may be changed in backwards-incompatible ways. So like... don't build your whole personality on them yet, mkay?

The cancelrecurringinvoice RPC command sends a cancellation message in place of an invoice_request. The BOLT 12 spec suggests sending this as a courtesy in place of the next invoice_request (as would be sent by fetchinvoice). Basically: you're ghosting your subscription, but politely, and the spec says it's the right thing to do 💖

Here's the whole cast of arguments, lowkey iconic lineup:

  • offer (string) — the offer string (must be recurring!) which we have been paying 🧚
  • recurrence_counter (u64) — one later than the last-specified recurrence_counter for the last invoice. yeah, one later, don't @ me
  • recurrence_label (string) — this must be the same as prior fetchinvoice calls for the same recurrence, because it's what links them together 🎀
  • recurrence_start (number, optional) — indicates what period number to start at (usually 0). this will be the same as previous fetchinvoice calls
  • payer_note (string, optional) — to tell the issuer the reason for the cancellation. use it kindly bestie 🥺
  • bip353 (string, optional) — BIP353 string (optionally with ₿) indicating where we fetched the offer from 🔥

⭐ RETURN VALUE ⭐

On success, an object is returned, containing:

  • bolt12 (string) — The invoice_request we sent to the issuer. that's your receipt, bestie, keep it 🫶

👑 AUTHOR 👑

Rusty Russell rusty@rustcorp.com.au is mainly responsible. slay, king 💜

🌈 SEE ALSO 🌈

🎀 RESOURCES 🎀

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

and that's the whole vibe check ✨ this page is from Core Lightning v26.06.9 — go forth and cancel your recurrences with grace, mwah 💋💅

📦 where this page comes from