Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OffersFetchInvoiceResponse

Hierarchy

  • OffersFetchInvoiceResponse

Index

Properties

changes?: { description?: string; description_appended?: string; msat?: string; vendor?: string; vendor_removed?: string }

Summary of changes from offer

Type declaration

  • Optional description?: string

    A completely replaced description field

  • Optional description_appended?: string

    extra characters appended to the description field

  • Optional msat?: string

    The amount, if different from the offer amount multiplied by any quantity

  • Optional vendor?: string

    A completely replaced vendor field

  • Optional vendor_removed?: string

    The vendor from the offer, which is missing in the invoice

invoice?: string

The bolt12-encoded invoice string, starting with "lni1"

next_period?: { counter?: number; endtime?: number; paywindow_end?: number; paywindow_start?: number; starttime?: number }

Only for recurring invoices if the next period is under the recurrence_limit

Type declaration

  • Optional counter?: number

    the index of the next period to fetchinvoice

  • Optional endtime?: number

    UNIX timestamp that the next period ends

  • Optional paywindow_end?: number

    UNIX timestamp of the latest time that the next invoice can be fetched

  • Optional paywindow_start?: number

    UNIX timestamp of the earliest time that the next invoice can be fetched

  • Optional starttime?: number

    UNIX timestamp that the next period starts

Generated using TypeDoc