Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
LIGHTNING-CANCELRECURRINGINVOICE(7)	   LIGHTNING-CANCELRECURRINGINVOICE(7)

NAME
       cancelrecurringinvoice  --  Command  for	sending	a cancel message for a
       recurring offer

SYNOPSIS
       cancelrecurringinvoice offer recurrence_counter	recurrence_label  [re-
       currence_start] [payer_note] [bip353]

DESCRIPTION
       Command added in	v25.09.

       NOTE:  Recurring	 offers	 are experimental, and may be changed in back-
       wards-incompable	ways.

       The cancelrecurringinvoice RPC command sends a cancellation message  in
       place  of an invoice_request.  The BOLT 12 specification	suggests send-
       ing this	as a courtesy in place of the next invoice_request  (as	 would
       be sent by fetchinvoice).

         offer	 (string): Offer string	(must be recurring) which we have been
	  paying.
         recurrence_counter (u64): One	later than the	last-specified	recur-
	  rence_counter	for the	last invoice.
         recurrence_label  (string):  This must be the	same as	prior fetchin-
	  voice	calls for the same recurrence, as it is	used to	link them  to-
	  gether.
         recurrence_start (number, optional): Indicates what period number to
	  start	 at  (usually  0).  This will be the same as previous fetchin-
	  voice	calls.
         payer_note (string, optional): To tell the issuer the	reason for the
	  cancellation.
         bip353 (string, optional): BIP353 string (optionally with ) indicat-
	  ing 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.

AUTHOR
       Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible.

SEE ALSO
       lightning-fetchinvoice(7)

RESOURCES
       Main web	site: <https://github.com/ElementsProject/lightning>

Core Lightning v25.12.1			   LIGHTNING-CANCELRECURRINGINVOICE(7)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=lightning-cancelrecurringinvoice&sektion=7&manpath=FreeBSD+Ports+15.1.quarterly>

home | help