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

FreeBSD Manual Pages

  
 
  

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

NAME
       lightning-disableoffer -- Command for removing an offer

SYNOPSIS
       disableoffer offer_id

DESCRIPTION
       The  disableoffer RPC command disables an offer,	so that	no further in-
       voices will be given out.

       We currently don't support deletion of offers, so offers	are  not  for-
       gotten entirely (there may be invoices which refer to this offer).

         offer_id (hash): The id we use to identify this offer.

RETURN VALUE
       Note:  the  returned  object is the same	format as listoffers.  On suc-
       cess, an	object is returned, containing:

         offer_id (hash): The merkle hash of the offer.
         active (boolean) (always false): Whether the offer can  produce  in-
	  voices/payments.
         single_use (boolean):	Whether	the offer is disabled after first suc-
	  cessful use.
         bolt12 (string): The bolt12 string representing this offer.
         used	(boolean): Whether the offer has had an	invoice	paid / payment
	  made.
         label	(string, optional): The	label provided when offer was created.

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

SEE ALSO
       lightning-enableoffer(7), lightning-offer(7), lightning-listoffers(7)

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

EXAMPLES
       Example 1:

       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",
	 "used": false
       }

Core Lightning v25.02				     LIGHTNING-DISABLEOFFER(7)

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

home | help