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

NAME
     delinvoice -- Command for removing an invoice (or just its description)

SYNOPSIS
     delinvoice label status [desconly]

DESCRIPTION
     The  delinvoice  RPC  command  removes  an  invoice with status as given in
     listinvoices, or with desconly set, removes its description.

     *	label (one of): Label of the invoice to be deleted.:
	*  (string)
	*  (u64)
     *	status (string) (one of "paid", "expired", "unpaid"): Label of	the  in-
	voice  to be deleted. The caller should be particularly aware of the er-
	ror case caused by the status changing just before this command  is  in-
	voked!
     *	desconly  (boolean,  optional):  If  set  to  True,  the  invoice is not
	deleted, but has its description removed (this can save space with  very
	large  descriptions,  as  would  be  used  with lightning-invoice(7) de-
	schashonly.

RETURN VALUE
     Note: The return is the same as an object	from  lightning-listinvoices(7).
     On success, an object is returned, containing:

     *	label (string): Unique label given at creation time.
     *	payment_hash  (hash):  The hash of the payment_preimage which will prove
	payment.
     *	created_index (u64): 1-based index indicating  order  this  invoice  was
	created in. (added v23.08)
     *	status (string) (one of "paid", "expired", "unpaid"): State of invoice.
     *	expires_at (u64): UNIX timestamp when invoice expires (or expired).
     *	bolt11 (string, optional): BOLT11 string.
     *	bolt12 (string, optional): BOLT12 string.
     *	amount_msat (msat, optional): The amount required to pay this invoice.
     *	description (string, optional): Description used in the invoice.
     *	updated_index  (u64,  optional): 1-based index indicating order this in-
	voice was changed (only present  if  it  has  changed  since  creation).
	(added v23.08)

     If  bolt12  is  present:  - local_offer_id (hex, optional): Offer for which
     this invoice was created.	- invreq_payer_note (string, optional): The  op-
     tional invreq_payer_note from invoice_request which created this invoice.

     If  status is "paid": - pay_index (u64): Unique index for this invoice pay-
     ment.  - amount_received_msat (msat): How much was  actually  received.   -
     paid_at  (u64):  UNIX  timestamp  of  when  payment  was  received.  - pay-
     ment_preimage (secret): SHA256 of this is the payment_hash offered  in  the
     invoice.

ERRORS
     The following errors may be reported:

     *	-1: Database error.
     *	905: An invoice with that label does not exist.
     *	906:  The  invoice  status does not match the parameter. An error object
	will be returned  as  error  data,  containing	current_status	and  ex-
	pected_status  fields.	This is most likely due to the status of the in-
	voice changing just before this command is invoked.
     *	908: The invoice already has no description, and desconly was set.

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

SEE ALSO
     lightning-listinvoices(7), lightning-waitinvoice(7),  lightning-invoice(7),
     lightning-autoclean-status(7)

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

EXAMPLES
     Example 1:

     Request:

     $ lightning-cli delinvoice -k "label"="lbl_l36" "status"="unpaid"

     {
       "id": "example:delinvoice#1",
       "method": "delinvoice",
       "params": {
	 "label": "lbl_l36",
	 "status": "unpaid"
       }
     }

     Response:

     {
       "label": "lbl_l36",
       "bolt11": "lnbcrt222n1pnt3005720bolt113000101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101",
       "payment_hash": "paymenthashdelinv10101010101010101010101010101010101010101010101",
       "amount_msat": 50000000,
       "status": "unpaid",
       "description": "l36 description",
       "expires_at": 1739000000,
       "created_index": 9
     }

     Example 2:

     Request:

     $ lightning-cli delinvoice -k "label"="lbl_l37" "status"="paid" "desconly"=True

     {
       "id": "example:delinvoice#2",
       "method": "delinvoice",
       "params": {
	 "label": "lbl_l37",
	 "status": "paid",
	 "desconly": true
       }
     }

     Response:

     {
       "label": "lbl_l37",
       "bolt11": "lnbcrt222n1pnt3005720bolt113000101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101",
       "payment_hash": "paymenthashdelinv20202020202020202020202020202020202020202020202",
       "amount_msat": 50000000,
       "status": "paid",
       "pay_index": 9,
       "amount_received_msat": 50000000,
       "paid_at": 1738500000,
       "payment_preimage": "paymentpreimagedelinv01010101010101010101010101010101010101010101",
       "expires_at": 1739000000,
       "created_index": 10,
       "updated_index": 9
     }

Core Lightning v26.06.1 				 LIGHTNING-DELINVOICE(7)
home | help