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

NAME
     cancelrecurringinvoice -- Command for sending a cancel message for a recur-
     ring offer

SYNOPSIS
     cancelrecurringinvoice  offer  recurrence_counter	recurrence_label [recur-
     rence_start] [payer_note] [bip353]

DESCRIPTION
     Command added in v25.09.

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

     The  cancelrecurringinvoice  RPC  command	sends  a cancellation message in
     place of an invoice_request.  The BOLT 12	specification  suggests  sending
     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 pay-
	ing.
     *	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 fetchinvoice
	calls for the same recurrence, as it is used to link 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.
     *	bip353 (string, optional): BIP353 string (optionally with a?) 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.

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 v26.06.1 		     LIGHTNING-CANCELRECURRINGINVOICE(7)

home | help