pl-api
    Preparing search index...

    Function subscriptionsCategory

    • Parameters

      Returns {
          cancelInvoice: (
              invoiceId: string,
          ) => Promise<
              {
                  amount: number;
                  chain_id: string;
                  created_at: string;
                  id: string;
                  invoice_expires_at: string;
                  payment_address: string;
                  recipient_id: string;
                  sender_id: string;
                  status: | "open"
                  | "forwarded"
                  | "paid"
                  | "timeout"
                  | "cancelled"
                  | "underpaid"
                  | "completed"
                  | "failed";
              },
          >;
          createInvoice: (
              senderId: string,
              recipientId: string,
              chainId: string,
              amount: number,
          ) => Promise<
              {
                  amount: number;
                  chain_id: string;
                  created_at: string;
                  id: string;
                  invoice_expires_at: string;
                  payment_address: string;
                  recipient_id: string;
                  sender_id: string;
                  status: | "open"
                  | "forwarded"
                  | "paid"
                  | "timeout"
                  | "cancelled"
                  | "underpaid"
                  | "completed"
                  | "failed";
              },
          >;
          createSubscription: (
              subscriberId: string,
              duration: number,
          ) => Promise<{ expires_at: string; id: number }>;
          findSubscription: (
              senderId: string,
              recipientId: string,
          ) => Promise<{ expires_at: string; id: number }>;
          getInvoice: (
              invoiceId: string,
          ) => Promise<
              {
                  amount: number;
                  chain_id: string;
                  created_at: string;
                  id: string;
                  invoice_expires_at: string;
                  payment_address: string;
                  recipient_id: string;
                  sender_id: string;
                  status: | "open"
                  | "forwarded"
                  | "paid"
                  | "timeout"
                  | "cancelled"
                  | "underpaid"
                  | "completed"
                  | "failed";
              },
          >;
          getSubscriptionOptions: () => Promise<
              {
                  chain_id: string;
                  payout_address: string;
                  price: number
                  | null;
                  type: "monero";
              }[],
          >;
          updateSubscription: (
              type: "monero",
              chainId?: string,
              price?: number,
              payoutAddress?: string,
          ) => Promise<Account>;
      }

      • cancelInvoice: (
            invoiceId: string,
        ) => Promise<
            {
                amount: number;
                chain_id: string;
                created_at: string;
                id: string;
                invoice_expires_at: string;
                payment_address: string;
                recipient_id: string;
                sender_id: string;
                status: | "open"
                | "forwarded"
                | "paid"
                | "timeout"
                | "cancelled"
                | "underpaid"
                | "completed"
                | "failed";
            },
        >

        Cancel invoice.

        Requires featuresFeatures.invoices.

      • createInvoice: (
            senderId: string,
            recipientId: string,
            chainId: string,
            amount: number,
        ) => Promise<
            {
                amount: number;
                chain_id: string;
                created_at: string;
                id: string;
                invoice_expires_at: string;
                payment_address: string;
                recipient_id: string;
                sender_id: string;
                status: | "open"
                | "forwarded"
                | "paid"
                | "timeout"
                | "cancelled"
                | "underpaid"
                | "completed"
                | "failed";
            },
        >

        Create invoice

        Requires featuresFeatures.subscriptions.

      • createSubscription: (
            subscriberId: string,
            duration: number,
        ) => Promise<{ expires_at: string; id: number }>

        Add subscriber or extend existing subscription. Can be used if blockchain integration is not enabled.

        Requires featuresFeatures.subscriptions.

      • findSubscription: (
            senderId: string,
            recipientId: string,
        ) => Promise<{ expires_at: string; id: number }>

        Find subscription by sender and recipient

        Requires featuresFeatures.subscriptions.

      • getInvoice: (
            invoiceId: string,
        ) => Promise<
            {
                amount: number;
                chain_id: string;
                created_at: string;
                id: string;
                invoice_expires_at: string;
                payment_address: string;
                recipient_id: string;
                sender_id: string;
                status: | "open"
                | "forwarded"
                | "paid"
                | "timeout"
                | "cancelled"
                | "underpaid"
                | "completed"
                | "failed";
            },
        >

        View information about an invoice.

        Requires featuresFeatures.invoices.

      • getSubscriptionOptions: () => Promise<
            {
                chain_id: string;
                payout_address: string;
                price: number
                | null;
                type: "monero";
            }[],
        >

        Get list of subscription options

        Requires featuresFeatures.subscriptions.

      • updateSubscription: (
            type: "monero",
            chainId?: string,
            price?: number,
            payoutAddress?: string,
        ) => Promise<Account>

        Enable subscriptions or update subscription settings

        Requires featuresFeatures.subscriptions.