43 lines
1.8 KiB
JSON
43 lines
1.8 KiB
JSON
{
|
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
"type": "object",
|
|
"required": [
|
|
"offer"
|
|
],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"offer": {
|
|
"type": "string",
|
|
"description": ""
|
|
},
|
|
"amount_msat": {
|
|
"type": "msat",
|
|
"description": "amount_msat is required if the offer does not specify an amount at all, otherwise it is optional (but presumably if you set it to less than the offer, you will get an error from the issuer)."
|
|
},
|
|
"quantity": {
|
|
"type": "u64",
|
|
"description": "quantity is is required if the offer specifies quantity_max, otherwise it is not allowed."
|
|
},
|
|
"recurrence_counter": {
|
|
"type": "u64",
|
|
"description": "recurrence_counter is required if the offer specifies recurrence, otherwise it is not allowed. recurrence_counter should first be set to 0, and incremented for each successive invoice in a given series."
|
|
},
|
|
"recurrence_start": {
|
|
"type": "number",
|
|
"description": "recurrence_start is required if the offer specifies recurrence_base with start_any_period set, otherwise it is not allowed. It indicates what period number to start at."
|
|
},
|
|
"recurrence_label": {
|
|
"type": "string",
|
|
"description": "recurrence_label is required if recurrence_counter is set, and otherwise is not allowed. It must be the same as prior fetchinvoice calls for the same recurrence, as it is used to link them together."
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"description": "timeout is an optional timeout; if we don't get a reply before this we fail (default, 60 seconds)."
|
|
},
|
|
"payer_note": {
|
|
"type": "string",
|
|
"description": "payer_note is an optional payer note to ask the issuer to include in the fetched invoice."
|
|
}
|
|
}
|
|
}
|