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

NAME
     disableoffer -- Command for removing an offer

SYNOPSIS
     disableoffer offer_id

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

     We  currently don't support deletion of offers, so offers are not forgotten
     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 success, 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 success-
	ful use.
     *	force_paths  (boolean): True if fronting_nodes (or the payment-fronting-
	node configuration entry) is set: implies any invoice  issued  for  this
	offer must use a subset of the same blinded paths. (added v26.04)
     *	bolt12 (string): The bolt12 string representing this offer.
     *	used  (boolean):  Whether  the	offer  has had an invoice paid / payment
	made.
     *	description (string, optional): The user-specified bolt 12  description.
	(added v26.04)
     *	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",
       "description": "Movie ticket",
       "used": false
     }

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