Package com.docusign.esign.api

Class BillingApi

  • public class BillingApi
extends Object
    BillingApi class.

    • Constructor Detail

      • BillingApi

        public BillingApi()
        BillingApi.

      • BillingApi

        public BillingApi​(ApiClient apiClient)
        BillingApi.

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()
        getApiClient Method.
        Returns:
        ApiClient

      • setApiClient

        public void setApiClient​(ApiClient apiClient)
        setApiClient Method.

      • getBillingPlan

        public BillingPlanResponse getBillingPlan​(String billingPlanId)
                                   throws ApiException
        Get the billing plan details.. Retrieves the billing plan details for the specified billing plan ID.
        Parameters:
        billingPlanId - The ID of the billing plan being accessed. (required)
        Returns:
        BillingPlanResponse
        Throws:
        ApiException - if fails to make API call

      • getBillingPlanWithHttpInfo

        public ApiResponse<BillingPlanResponse> getBillingPlanWithHttpInfo​(String billingPlanId)
                                                            throws ApiException
        Get the billing plan details. Retrieves the billing plan details for the specified billing plan ID.
        Parameters:
        billingPlanId - The ID of the billing plan being accessed. (required)
        Returns:
        BillingPlanResponse
        Throws:
        ApiException - if fails to make API call

      • getCreditCardInfo

        public CreditCardInformation getCreditCardInfo​(String accountId)
                                        throws ApiException
        Get metadata for a given credit card.. This method returns information about a credit card associated with an account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        CreditCardInformation
        Throws:
        ApiException - if fails to make API call

      • getCreditCardInfoWithHttpInfo

        public ApiResponse<CreditCardInformation> getCreditCardInfoWithHttpInfo​(String accountId)
                                                                 throws ApiException
        Get metadata for a given credit card. This method returns information about a credit card associated with an account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        CreditCardInformation
        Throws:
        ApiException - if fails to make API call

      • getDowngradeRequestBillingInfo

        public DowngradRequestBillingInfoResponse getDowngradeRequestBillingInfo​(String accountId)
                                                                  throws ApiException
        Returns downgrade plan information for the specified account..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        DowngradRequestBillingInfoResponse
        Throws:
        ApiException - if fails to make API call

      • getDowngradeRequestBillingInfoWithHttpInfo

        public ApiResponse<DowngradRequestBillingInfoResponse> getDowngradeRequestBillingInfoWithHttpInfo​(String accountId)
                                                                                           throws ApiException
        Returns downgrade plan information for the specified account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        DowngradRequestBillingInfoResponse
        Throws:
        ApiException - if fails to make API call

      • getInvoice

        public BillingInvoice getInvoice​(String accountId,
                                 String invoiceId)
                          throws ApiException
        Retrieves a billing invoice.. Retrieves the specified invoice. ###### Note: If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account. **Response** The following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check | ID Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge |
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        invoiceId - (required)
        Returns:
        BillingInvoice
        Throws:
        ApiException - if fails to make API call

      • getInvoiceWithHttpInfo

        public ApiResponse<BillingInvoice> getInvoiceWithHttpInfo​(String accountId,
                                                          String invoiceId)
                                                   throws ApiException
        Retrieves a billing invoice. Retrieves the specified invoice. ###### Note: If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account. **Response** The following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check | ID Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge |
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        invoiceId - (required)
        Returns:
        BillingInvoice
        Throws:
        ApiException - if fails to make API call

      • getPayment

        public BillingPaymentItem getPayment​(String accountId,
                                     String paymentId)
                              throws ApiException
        Gets billing payment information for a specific payment.. Retrieves the information for a specified payment. Privileges required: account administrator
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        paymentId - (required)
        Returns:
        BillingPaymentItem
        Throws:
        ApiException - if fails to make API call

      • getPaymentWithHttpInfo

        public ApiResponse<BillingPaymentItem> getPaymentWithHttpInfo​(String accountId,
                                                              String paymentId)
                                                       throws ApiException
        Gets billing payment information for a specific payment. Retrieves the information for a specified payment. Privileges required: account administrator
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        paymentId - (required)
        Returns:
        BillingPaymentItem
        Throws:
        ApiException - if fails to make API call

      • getPlan

        public AccountBillingPlanResponse getPlan​(String accountId)
                                   throws ApiException
        Get Account Billing Plan. Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card. By default the successor plan and credit card information is included in the response. This information can be excluded from the response by adding the appropriate optional query string with the `setting` set to **false**. Response The response returns the billing plan information, including the currency code, for the plan. The `billingPlan` and `succesorPlans` property values are the same as those shown in the [ML:Get Billing Plan Details] reference. the `billingAddress` and `creditCardInformation` property values are the same as those shown in the [ML:Update Billing Plan] reference. ###### Note: When credit card number information is shown, a mask is applied to the response so that only the last 4 digits of the card number are visible.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        AccountBillingPlanResponse
        Throws:
        ApiException

      • getPlan

        public AccountBillingPlanResponse getPlan​(String accountId,
                                          BillingApi.GetPlanOptions options)
                                   throws ApiException
        Get Account Billing Plan. Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card. By default the successor plan and credit card information is included in the response. This information can be excluded from the response by adding the appropriate optional query string with the `setting` set to **false**. Response The response returns the billing plan information, including the currency code, for the plan. The `billingPlan` and `succesorPlans` property values are the same as those shown in the [ML:Get Billing Plan Details] reference. the `billingAddress` and `creditCardInformation` property values are the same as those shown in the [ML:Update Billing Plan] reference. ###### Note: When credit card number information is shown, a mask is applied to the response so that only the last 4 digits of the card number are visible.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        options - for modifying the method behavior.
        Returns:
        AccountBillingPlanResponse
        Throws:
        ApiException - if fails to make API call

      • getPlanWithHttpInfo

        public ApiResponse<AccountBillingPlanResponse> getPlanWithHttpInfo​(String accountId,
                                                                   BillingApi.GetPlanOptions options)
                                                            throws ApiException
        Get Account Billing Plan Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card. By default the successor plan and credit card information is included in the response. This information can be excluded from the response by adding the appropriate optional query string with the `setting` set to **false**. Response The response returns the billing plan information, including the currency code, for the plan. The `billingPlan` and `succesorPlans` property values are the same as those shown in the [ML:Get Billing Plan Details] reference. the `billingAddress` and `creditCardInformation` property values are the same as those shown in the [ML:Update Billing Plan] reference. ###### Note: When credit card number information is shown, a mask is applied to the response so that only the last 4 digits of the card number are visible.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        options - for modifying the method behavior.
        Returns:
        AccountBillingPlanResponse
        Throws:
        ApiException - if fails to make API call

      • listBillingPlans

        public BillingPlansResponse listBillingPlans()
                                      throws ApiException
        Gets the list of available billing plans.. Retrieves a list of the billing plans associated with a distributor.
        Returns:
        BillingPlansResponse
        Throws:
        ApiException - if fails to make API call

      • listBillingPlansWithHttpInfo

        public ApiResponse<BillingPlansResponse> listBillingPlansWithHttpInfo()
                                                               throws ApiException
        Gets the list of available billing plans. Retrieves a list of the billing plans associated with a distributor.
        Returns:
        BillingPlansResponse
        Throws:
        ApiException - if fails to make API call

      • listInvoices

        public BillingInvoicesResponse listInvoices​(String accountId)
                                     throws ApiException
        Get a List of Billing Invoices. Retrieves a list of invoices for the account. If the from date or to date queries are not specified, the response returns invoices for the last 365 days. Privileges required: account administrator
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        BillingInvoicesResponse
        Throws:
        ApiException

      • listInvoices

        public BillingInvoicesResponse listInvoices​(String accountId,
                                            BillingApi.ListInvoicesOptions options)
                                     throws ApiException
        Get a List of Billing Invoices. Retrieves a list of invoices for the account. If the from date or to date queries are not specified, the response returns invoices for the last 365 days. Privileges required: account administrator
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        options - for modifying the method behavior.
        Returns:
        BillingInvoicesResponse
        Throws:
        ApiException - if fails to make API call

      • listInvoicesWithHttpInfo

        public ApiResponse<BillingInvoicesResponse> listInvoicesWithHttpInfo​(String accountId,
                                                                     BillingApi.ListInvoicesOptions options)
                                                              throws ApiException
        Get a List of Billing Invoices Retrieves a list of invoices for the account. If the from date or to date queries are not specified, the response returns invoices for the last 365 days. Privileges required: account administrator
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        options - for modifying the method behavior.
        Returns:
        BillingInvoicesResponse
        Throws:
        ApiException - if fails to make API call

      • listInvoicesPastDue

        public BillingInvoicesSummary listInvoicesPastDue​(String accountId)
                                           throws ApiException
        Get a list of past due invoices.. Returns a list past due invoices for the account and notes if payment can be made through the REST API. Privileges Required: account administrator
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        BillingInvoicesSummary
        Throws:
        ApiException - if fails to make API call

      • listInvoicesPastDueWithHttpInfo

        public ApiResponse<BillingInvoicesSummary> listInvoicesPastDueWithHttpInfo​(String accountId)
                                                                    throws ApiException
        Get a list of past due invoices. Returns a list past due invoices for the account and notes if payment can be made through the REST API. Privileges Required: account administrator
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        BillingInvoicesSummary
        Throws:
        ApiException - if fails to make API call

      • listPayments

        public BillingPaymentsResponse listPayments​(String accountId)
                                     throws ApiException
        Gets payment information for one or more payments.. Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days. Privileges required: account administrator
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        BillingPaymentsResponse
        Throws:
        ApiException

      • listPayments

        public BillingPaymentsResponse listPayments​(String accountId,
                                            BillingApi.ListPaymentsOptions options)
                                     throws ApiException
        Gets payment information for one or more payments.. Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days. Privileges required: account administrator
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        options - for modifying the method behavior.
        Returns:
        BillingPaymentsResponse
        Throws:
        ApiException - if fails to make API call

      • listPaymentsWithHttpInfo

        public ApiResponse<BillingPaymentsResponse> listPaymentsWithHttpInfo​(String accountId,
                                                                     BillingApi.ListPaymentsOptions options)
                                                              throws ApiException
        Gets payment information for one or more payments. Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days. Privileges required: account administrator
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        options - for modifying the method behavior.
        Returns:
        BillingPaymentsResponse
        Throws:
        ApiException - if fails to make API call

      • makePayment

        public BillingPaymentResponse makePayment​(String accountId,
                                          BillingPaymentRequest billingPaymentRequest)
                                   throws ApiException
        Posts a payment to a past due invoice.. Posts a payment to a past due invoice. ###### Note: This can only be used if the `paymentAllowed` value for a past due invoice is true. This can be determined calling [ML:GetBillingInvoicesPastDue]. The response returns information for a single payment, if a payment ID was used in the endpoint, or a list of payments. If the from date or to date queries or payment ID are not used, the response returns payment information for the last 365 days. If the request was for a single payment ID, the `nextUri` and `previousUri` properties are not returned. Privileges required: account administrator
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        billingPaymentRequest - (optional)
        Returns:
        BillingPaymentResponse
        Throws:
        ApiException - if fails to make API call

      • makePaymentWithHttpInfo

        public ApiResponse<BillingPaymentResponse> makePaymentWithHttpInfo​(String accountId,
                                                                   BillingPaymentRequest billingPaymentRequest)
                                                            throws ApiException
        Posts a payment to a past due invoice. Posts a payment to a past due invoice. ###### Note: This can only be used if the `paymentAllowed` value for a past due invoice is true. This can be determined calling [ML:GetBillingInvoicesPastDue]. The response returns information for a single payment, if a payment ID was used in the endpoint, or a list of payments. If the from date or to date queries or payment ID are not used, the response returns payment information for the last 365 days. If the request was for a single payment ID, the `nextUri` and `previousUri` properties are not returned. Privileges required: account administrator
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        billingPaymentRequest - (optional)
        Returns:
        BillingPaymentResponse
        Throws:
        ApiException - if fails to make API call

      • purchaseEnvelopes

        public void purchaseEnvelopes​(String accountId,
                              PurchasedEnvelopesInformation purchasedEnvelopesInformation)
                       throws ApiException
        Reserverd: Purchase additional envelopes.. Reserved: At this time, this endpoint is limited to DocuSign internal use only. Completes the purchase of envelopes for your account. The actual purchase is done as part of an internal workflow interaction with an envelope vendor.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        purchasedEnvelopesInformation - (optional)
        Throws:
        ApiException - if fails to make API call

      • purchaseEnvelopesWithHttpInfo

        public ApiResponse<Object> purchaseEnvelopesWithHttpInfo​(String accountId,
                                                         PurchasedEnvelopesInformation purchasedEnvelopesInformation)
                                                  throws ApiException
        Reserverd: Purchase additional envelopes. Reserved: At this time, this endpoint is limited to DocuSign internal use only. Completes the purchase of envelopes for your account. The actual purchase is done as part of an internal workflow interaction with an envelope vendor.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        purchasedEnvelopesInformation - (optional)
        Throws:
        ApiException - if fails to make API call

      • updateDowngradeAccountBillingPlan

        public DowngradePlanUpdateResponse updateDowngradeAccountBillingPlan​(String accountId,
                                                                     DowngradeBillingPlanInformation downgradeBillingPlanInformation)
                                                              throws ApiException
        Queues downgrade billing plan request for an account..
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        downgradeBillingPlanInformation - (optional)
        Returns:
        DowngradePlanUpdateResponse
        Throws:
        ApiException - if fails to make API call

      • updateDowngradeAccountBillingPlanWithHttpInfo

        public ApiResponse<DowngradePlanUpdateResponse> updateDowngradeAccountBillingPlanWithHttpInfo​(String accountId,
                                                                                              DowngradeBillingPlanInformation downgradeBillingPlanInformation)
                                                                                       throws ApiException
        Queues downgrade billing plan request for an account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        downgradeBillingPlanInformation - (optional)
        Returns:
        DowngradePlanUpdateResponse
        Throws:
        ApiException - if fails to make API call

      • updatePlan

        public BillingPlanUpdateResponse updatePlan​(String accountId,
                                            BillingPlanInformation billingPlanInformation)
                                     throws ApiException
        Updates the account billing plan.. Updates the billing plan information, billing address, and credit card information for the specified account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        billingPlanInformation - (optional)
        Returns:
        BillingPlanUpdateResponse
        Throws:
        ApiException

      • updatePlan

        public BillingPlanUpdateResponse updatePlan​(String accountId,
                                            BillingPlanInformation billingPlanInformation,
                                            BillingApi.UpdatePlanOptions options)
                                     throws ApiException
        Updates the account billing plan.. Updates the billing plan information, billing address, and credit card information for the specified account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        billingPlanInformation - (optional)
        options - for modifying the method behavior.
        Returns:
        BillingPlanUpdateResponse
        Throws:
        ApiException - if fails to make API call

      • updatePlanWithHttpInfo

        public ApiResponse<BillingPlanUpdateResponse> updatePlanWithHttpInfo​(String accountId,
                                                                     BillingPlanInformation billingPlanInformation,
                                                                     BillingApi.UpdatePlanOptions options)
                                                              throws ApiException
        Updates the account billing plan. Updates the billing plan information, billing address, and credit card information for the specified account.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        billingPlanInformation - (optional)
        options - for modifying the method behavior.
        Returns:
        BillingPlanUpdateResponse
        Throws:
        ApiException - if fails to make API call