Class BillingClient

Type declaration

• Readonly methods: {
      getCurrentMonthUsage: {
          I: typeof GetCurrentMonthUsageRequest;
          O: typeof GetCurrentMonthUsageResponse;
          kind: Unary;
          name: "GetCurrentMonthUsage";
      };
      getInvoicePdf: {
          I: typeof GetInvoicePdfRequest;
          O: typeof GetInvoicePdfResponse;
          kind: ServerStreaming;
          name: "GetInvoicePdf";
      };
      getInvoicesSummary: {
          I: typeof GetInvoicesSummaryRequest;
          O: typeof GetInvoicesSummaryResponse;
          kind: Unary;
          name: "GetInvoicesSummary";
      };
      getOrgBillingInformation: {
          I: typeof GetOrgBillingInformationRequest;
          O: typeof GetOrgBillingInformationResponse;
          kind: Unary;
          name: "GetOrgBillingInformation";
      };
      sendPaymentRequiredEmail: {
          I: typeof SendPaymentRequiredEmailRequest;
          O: typeof SendPaymentRequiredEmailResponse;
          kind: Unary;
          name: "SendPaymentRequiredEmail";
      };
  }

  • Readonly getCurrentMonthUsage: {
        I: typeof GetCurrentMonthUsageRequest;
        O: typeof GetCurrentMonthUsageResponse;
        kind: Unary;
        name: "GetCurrentMonthUsage";
    }

    Detailed breakdown of current month's costs

    Generated

    from rpc viam.app.v1.BillingService.GetCurrentMonthUsage

    • Readonly I: typeof GetCurrentMonthUsageRequest

    • Readonly O: typeof GetCurrentMonthUsageResponse

    • Readonly kind: Unary

    • Readonly name: "GetCurrentMonthUsage"

  • Readonly getInvoicePdf: {
        I: typeof GetInvoicePdfRequest;
        O: typeof GetInvoicePdfResponse;
        kind: ServerStreaming;
        name: "GetInvoicePdf";
    }

    Download a PDF invoice

    Generated

    from rpc viam.app.v1.BillingService.GetInvoicePdf

    • Readonly I: typeof GetInvoicePdfRequest

    • Readonly O: typeof GetInvoicePdfResponse

    • Readonly kind: ServerStreaming

    • Readonly name: "GetInvoicePdf"

  • Readonly getInvoicesSummary: {
        I: typeof GetInvoicesSummaryRequest;
        O: typeof GetInvoicesSummaryResponse;
        kind: Unary;
        name: "GetInvoicesSummary";
    }

    Total outstanding balance and previous invoices

    Generated

    from rpc viam.app.v1.BillingService.GetInvoicesSummary

    • Readonly I: typeof GetInvoicesSummaryRequest

    • Readonly O: typeof GetInvoicesSummaryResponse

    • Readonly kind: Unary

    • Readonly name: "GetInvoicesSummary"

  • Readonly getOrgBillingInformation: {
        I: typeof GetOrgBillingInformationRequest;
        O: typeof GetOrgBillingInformationResponse;
        kind: Unary;
        name: "GetOrgBillingInformation";
    }

    Org-level information (like billing email and payment details)

    Generated

    from rpc viam.app.v1.BillingService.GetOrgBillingInformation

    • Readonly I: typeof GetOrgBillingInformationRequest

    • Readonly O: typeof GetOrgBillingInformationResponse

    • Readonly kind: Unary

    • Readonly name: "GetOrgBillingInformation"

  • Readonly sendPaymentRequiredEmail: {
        I: typeof SendPaymentRequiredEmailRequest;
        O: typeof SendPaymentRequiredEmailResponse;
        kind: Unary;
        name: "SendPaymentRequiredEmail";
    }

    Send an email with a prompt to the user's org's billing page.

    Generated

    from rpc viam.app.v1.BillingService.SendPaymentRequiredEmail

    • Readonly I: typeof SendPaymentRequiredEmailRequest

    • Readonly O: typeof SendPaymentRequiredEmailResponse

    • Readonly kind: Unary

    • Readonly name: "SendPaymentRequiredEmail"

• Readonly typeName: "viam.app.v1.BillingService"