Represents a collection of functions to interact with the API endpoints More...
Public Member Functions | |
| BillingPlanResponse | GetBillingPlan (string billingPlanId) |
| Get the billing plan details. More... | |
| ApiResponse< BillingPlanResponse > | GetBillingPlanWithHttpInfo (string billingPlanId) |
| Get the billing plan details. More... | |
| CreditCardInformation | GetCreditCardInfo (string accountId) |
| Get metadata for a given credit card. More... | |
| ApiResponse< CreditCardInformation > | GetCreditCardInfoWithHttpInfo (string accountId) |
| Get metadata for a given credit card. More... | |
| DowngradRequestBillingInfoResponse | GetDowngradeRequestBillingInfo (string accountId) |
| Returns downgrade plan information for the specified account. More... | |
| ApiResponse< DowngradRequestBillingInfoResponse > | GetDowngradeRequestBillingInfoWithHttpInfo (string accountId) |
| Returns downgrade plan information for the specified account. More... | |
| BillingInvoice | GetInvoice (string accountId, string invoiceId) |
| Retrieves a billing invoice. More... | |
| ApiResponse< BillingInvoice > | GetInvoiceWithHttpInfo (string accountId, string invoiceId) |
| Retrieves a billing invoice. More... | |
| BillingPaymentItem | GetPayment (string accountId, string paymentId) |
| Gets billing payment information for a specific payment. More... | |
| ApiResponse< BillingPaymentItem > | GetPaymentWithHttpInfo (string accountId, string paymentId) |
| Gets billing payment information for a specific payment. More... | |
| AccountBillingPlanResponse | GetPlan (string accountId, BillingApi.GetPlanOptions options=null) |
| Get Account Billing Plan More... | |
| ApiResponse< AccountBillingPlanResponse > | GetPlanWithHttpInfo (string accountId, BillingApi.GetPlanOptions options=null) |
| Get Account Billing Plan More... | |
| BillingPlansResponse | ListBillingPlans () |
| Gets the list of available billing plans. More... | |
| ApiResponse< BillingPlansResponse > | ListBillingPlansWithHttpInfo () |
| Gets the list of available billing plans. More... | |
| BillingInvoicesResponse | ListInvoices (string accountId, BillingApi.ListInvoicesOptions options=null) |
| Get a List of Billing Invoices More... | |
| ApiResponse< BillingInvoicesResponse > | ListInvoicesWithHttpInfo (string accountId, BillingApi.ListInvoicesOptions options=null) |
| Get a List of Billing Invoices More... | |
| BillingInvoicesSummary | ListInvoicesPastDue (string accountId) |
| Get a list of past due invoices. More... | |
| ApiResponse< BillingInvoicesSummary > | ListInvoicesPastDueWithHttpInfo (string accountId) |
| Get a list of past due invoices. More... | |
| BillingPaymentsResponse | ListPayments (string accountId, BillingApi.ListPaymentsOptions options=null) |
| Gets payment information for one or more payments. More... | |
| ApiResponse< BillingPaymentsResponse > | ListPaymentsWithHttpInfo (string accountId, BillingApi.ListPaymentsOptions options=null) |
| Gets payment information for one or more payments. More... | |
| BillingPaymentResponse | MakePayment (string accountId, BillingPaymentRequest billingPaymentRequest=null) |
| Posts a payment to a past due invoice. More... | |
| ApiResponse< BillingPaymentResponse > | MakePaymentWithHttpInfo (string accountId, BillingPaymentRequest billingPaymentRequest=null) |
| Posts a payment to a past due invoice. More... | |
| void | PurchaseEnvelopes (string accountId, PurchasedEnvelopesInformation purchasedEnvelopesInformation=null) |
| Reserverd: Purchase additional envelopes. More... | |
| ApiResponse< Object > | PurchaseEnvelopesWithHttpInfo (string accountId, PurchasedEnvelopesInformation purchasedEnvelopesInformation=null) |
| Reserverd: Purchase additional envelopes. More... | |
| DowngradePlanUpdateResponse | UpdateDowngradeAccountBillingPlan (string accountId, DowngradeBillingPlanInformation downgradeBillingPlanInformation=null) |
| Queues downgrade billing plan request for an account. More... | |
| ApiResponse< DowngradePlanUpdateResponse > | UpdateDowngradeAccountBillingPlanWithHttpInfo (string accountId, DowngradeBillingPlanInformation downgradeBillingPlanInformation=null) |
| Queues downgrade billing plan request for an account. More... | |
| BillingPlanUpdateResponse | UpdatePlan (string accountId, BillingPlanInformation billingPlanInformation=null, BillingApi.UpdatePlanOptions options=null) |
| Updates the account billing plan. More... | |
| ApiResponse< BillingPlanUpdateResponse > | UpdatePlanWithHttpInfo (string accountId, BillingPlanInformation billingPlanInformation=null, BillingApi.UpdatePlanOptions options=null) |
| Updates the account billing plan. More... | |
| System.Threading.Tasks.Task< BillingPlanResponse > | GetBillingPlanAsync (string billingPlanId) |
| Get the billing plan details. More... | |
| System.Threading.Tasks.Task< ApiResponse< BillingPlanResponse > > | GetBillingPlanAsyncWithHttpInfo (string billingPlanId) |
| Get the billing plan details. More... | |
| System.Threading.Tasks.Task< CreditCardInformation > | GetCreditCardInfoAsync (string accountId) |
| Get metadata for a given credit card. More... | |
| System.Threading.Tasks.Task< ApiResponse< CreditCardInformation > > | GetCreditCardInfoAsyncWithHttpInfo (string accountId) |
| Get metadata for a given credit card. More... | |
| System.Threading.Tasks.Task< DowngradRequestBillingInfoResponse > | GetDowngradeRequestBillingInfoAsync (string accountId) |
| Returns downgrade plan information for the specified account. More... | |
| System.Threading.Tasks.Task< ApiResponse< DowngradRequestBillingInfoResponse > > | GetDowngradeRequestBillingInfoAsyncWithHttpInfo (string accountId) |
| Returns downgrade plan information for the specified account. More... | |
| System.Threading.Tasks.Task< BillingInvoice > | GetInvoiceAsync (string accountId, string invoiceId) |
| Retrieves a billing invoice. More... | |
| System.Threading.Tasks.Task< ApiResponse< BillingInvoice > > | GetInvoiceAsyncWithHttpInfo (string accountId, string invoiceId) |
| Retrieves a billing invoice. More... | |
| System.Threading.Tasks.Task< BillingPaymentItem > | GetPaymentAsync (string accountId, string paymentId) |
| Gets billing payment information for a specific payment. More... | |
| System.Threading.Tasks.Task< ApiResponse< BillingPaymentItem > > | GetPaymentAsyncWithHttpInfo (string accountId, string paymentId) |
| Gets billing payment information for a specific payment. More... | |
| System.Threading.Tasks.Task< AccountBillingPlanResponse > | GetPlanAsync (string accountId, BillingApi.GetPlanOptions options=null) |
| Get Account Billing Plan More... | |
| System.Threading.Tasks.Task< ApiResponse< AccountBillingPlanResponse > > | GetPlanAsyncWithHttpInfo (string accountId, BillingApi.GetPlanOptions options=null) |
| Get Account Billing Plan More... | |
| System.Threading.Tasks.Task< BillingPlansResponse > | ListBillingPlansAsync () |
| Gets the list of available billing plans. More... | |
| System.Threading.Tasks.Task< ApiResponse< BillingPlansResponse > > | ListBillingPlansAsyncWithHttpInfo () |
| Gets the list of available billing plans. More... | |
| System.Threading.Tasks.Task< BillingInvoicesResponse > | ListInvoicesAsync (string accountId, BillingApi.ListInvoicesOptions options=null) |
| Get a List of Billing Invoices More... | |
| System.Threading.Tasks.Task< ApiResponse< BillingInvoicesResponse > > | ListInvoicesAsyncWithHttpInfo (string accountId, BillingApi.ListInvoicesOptions options=null) |
| Get a List of Billing Invoices More... | |
| System.Threading.Tasks.Task< BillingInvoicesSummary > | ListInvoicesPastDueAsync (string accountId) |
| Get a list of past due invoices. More... | |
| System.Threading.Tasks.Task< ApiResponse< BillingInvoicesSummary > > | ListInvoicesPastDueAsyncWithHttpInfo (string accountId) |
| Get a list of past due invoices. More... | |
| System.Threading.Tasks.Task< BillingPaymentsResponse > | ListPaymentsAsync (string accountId, BillingApi.ListPaymentsOptions options=null) |
| Gets payment information for one or more payments. More... | |
| System.Threading.Tasks.Task< ApiResponse< BillingPaymentsResponse > > | ListPaymentsAsyncWithHttpInfo (string accountId, BillingApi.ListPaymentsOptions options=null) |
| Gets payment information for one or more payments. More... | |
| System.Threading.Tasks.Task< BillingPaymentResponse > | MakePaymentAsync (string accountId, BillingPaymentRequest billingPaymentRequest=null) |
| Posts a payment to a past due invoice. More... | |
| System.Threading.Tasks.Task< ApiResponse< BillingPaymentResponse > > | MakePaymentAsyncWithHttpInfo (string accountId, BillingPaymentRequest billingPaymentRequest=null) |
| Posts a payment to a past due invoice. More... | |
| System.Threading.Tasks.Task | PurchaseEnvelopesAsync (string accountId, PurchasedEnvelopesInformation purchasedEnvelopesInformation=null) |
| Reserverd: Purchase additional envelopes. More... | |
| System.Threading.Tasks.Task< ApiResponse< Object > > | PurchaseEnvelopesAsyncWithHttpInfo (string accountId, PurchasedEnvelopesInformation purchasedEnvelopesInformation=null) |
| Reserverd: Purchase additional envelopes. More... | |
| System.Threading.Tasks.Task< DowngradePlanUpdateResponse > | UpdateDowngradeAccountBillingPlanAsync (string accountId, DowngradeBillingPlanInformation downgradeBillingPlanInformation=null) |
| Queues downgrade billing plan request for an account. More... | |
| System.Threading.Tasks.Task< ApiResponse< DowngradePlanUpdateResponse > > | UpdateDowngradeAccountBillingPlanAsyncWithHttpInfo (string accountId, DowngradeBillingPlanInformation downgradeBillingPlanInformation=null) |
| Queues downgrade billing plan request for an account. More... | |
| System.Threading.Tasks.Task< BillingPlanUpdateResponse > | UpdatePlanAsync (string accountId, BillingPlanInformation billingPlanInformation=null, BillingApi.UpdatePlanOptions options=null) |
| Updates the account billing plan. More... | |
| System.Threading.Tasks.Task< ApiResponse< BillingPlanUpdateResponse > > | UpdatePlanAsyncWithHttpInfo (string accountId, BillingPlanInformation billingPlanInformation=null, BillingApi.UpdatePlanOptions options=null) |
| Updates the account billing plan. More... | |
 Public Member Functions inherited from DocuSign.eSign.Client.IApiAccessor | |
| String | GetBasePath () |
| Gets the base path of the API client. More... | |
Additional Inherited Members | |
| Properties inherited from DocuSign.eSign.Client.IApiAccessor | |
| DocuSignClient | ApiClient [get, set] |
| Gets or sets the ApiClient object More... | |
| ExceptionFactory | ExceptionFactory [get, set] |
| Provides a factory method hook for the creation of exceptions. More... | |
Detailed Description
Represents a collection of functions to interact with the API endpoints
Member Function Documentation
◆ GetBillingPlan()
| BillingPlanResponse DocuSign.eSign.Api.IBillingApi.GetBillingPlan | ( | string | billingPlanId | ) |
Get the billing plan details.
Retrieves the billing plan details for the specified billing plan ID.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
billingPlanId The ID of the billing plan being accessed.
- Returns
Implemented in DocuSign.eSign.Api.BillingApi.
◆ GetBillingPlanAsync()
| System.Threading.Tasks.Task<BillingPlanResponse> DocuSign.eSign.Api.IBillingApi.GetBillingPlanAsync | ( | string | billingPlanId | ) |
Get the billing plan details.
Retrieves the billing plan details for the specified billing plan ID.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
billingPlanId The ID of the billing plan being accessed.
- Returns
- Task of BillingPlanResponse
Implemented in DocuSign.eSign.Api.BillingApi.
◆ GetBillingPlanAsyncWithHttpInfo()
| System.Threading.Tasks.Task<ApiResponse<BillingPlanResponse> > DocuSign.eSign.Api.IBillingApi.GetBillingPlanAsyncWithHttpInfo | ( | string | billingPlanId | ) |
Get the billing plan details.
Retrieves the billing plan details for the specified billing plan ID.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
billingPlanId The ID of the billing plan being accessed.
- Returns
- Task of ApiResponse (BillingPlanResponse)
Implemented in DocuSign.eSign.Api.BillingApi.
◆ GetBillingPlanWithHttpInfo()
| ApiResponse<BillingPlanResponse> DocuSign.eSign.Api.IBillingApi.GetBillingPlanWithHttpInfo | ( | string | billingPlanId | ) |
Get the billing plan details.
Retrieves the billing plan details for the specified billing plan ID.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
billingPlanId The ID of the billing plan being accessed.
- Returns
- ApiResponse of
Implemented in DocuSign.eSign.Api.BillingApi.
◆ GetCreditCardInfo()
| CreditCardInformation DocuSign.eSign.Api.IBillingApi.GetCreditCardInfo | ( | string | accountId | ) |
Get metadata for a given credit card.
This method returns information about a credit card associated with an account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid.
- Returns
Implemented in DocuSign.eSign.Api.BillingApi.
◆ GetCreditCardInfoAsync()
| System.Threading.Tasks.Task<CreditCardInformation> DocuSign.eSign.Api.IBillingApi.GetCreditCardInfoAsync | ( | string | accountId | ) |
Get metadata for a given credit card.
This method returns information about a credit card associated with an account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid.
- Returns
- Task of CreditCardInformation
Implemented in DocuSign.eSign.Api.BillingApi.
◆ GetCreditCardInfoAsyncWithHttpInfo()
| System.Threading.Tasks.Task<ApiResponse<CreditCardInformation> > DocuSign.eSign.Api.IBillingApi.GetCreditCardInfoAsyncWithHttpInfo | ( | string | accountId | ) |
Get metadata for a given credit card.
This method returns information about a credit card associated with an account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid.
- Returns
- Task of ApiResponse (CreditCardInformation)
Implemented in DocuSign.eSign.Api.BillingApi.
◆ GetCreditCardInfoWithHttpInfo()
| ApiResponse<CreditCardInformation> DocuSign.eSign.Api.IBillingApi.GetCreditCardInfoWithHttpInfo | ( | string | accountId | ) |
Get metadata for a given credit card.
This method returns information about a credit card associated with an account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid.
- Returns
- ApiResponse of
Implemented in DocuSign.eSign.Api.BillingApi.
◆ GetDowngradeRequestBillingInfo()
| DowngradRequestBillingInfoResponse DocuSign.eSign.Api.IBillingApi.GetDowngradeRequestBillingInfo | ( | string | accountId | ) |
Returns downgrade plan information for the specified account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid.
- Returns
Implemented in DocuSign.eSign.Api.BillingApi.
◆ GetDowngradeRequestBillingInfoAsync()
| System.Threading.Tasks.Task<DowngradRequestBillingInfoResponse> DocuSign.eSign.Api.IBillingApi.GetDowngradeRequestBillingInfoAsync | ( | string | accountId | ) |
Returns downgrade plan information for the specified account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid.
- Returns
- Task of DowngradRequestBillingInfoResponse
Implemented in DocuSign.eSign.Api.BillingApi.
◆ GetDowngradeRequestBillingInfoAsyncWithHttpInfo()
| System.Threading.Tasks.Task<ApiResponse<DowngradRequestBillingInfoResponse> > DocuSign.eSign.Api.IBillingApi.GetDowngradeRequestBillingInfoAsyncWithHttpInfo | ( | string | accountId | ) |
Returns downgrade plan information for the specified account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid.
- Returns
- Task of ApiResponse (DowngradRequestBillingInfoResponse)
Implemented in DocuSign.eSign.Api.BillingApi.
◆ GetDowngradeRequestBillingInfoWithHttpInfo()
| ApiResponse<DowngradRequestBillingInfoResponse> DocuSign.eSign.Api.IBillingApi.GetDowngradeRequestBillingInfoWithHttpInfo | ( | string | accountId | ) |
Returns downgrade plan information for the specified account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid.
- Returns
- ApiResponse of
Implemented in DocuSign.eSign.Api.BillingApi.
◆ GetInvoice()
| BillingInvoice DocuSign.eSign.Api.IBillingApi.GetInvoice | ( | string | accountId, |
| string | invoiceId | ||
| ) |
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 |
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. invoiceId
- Returns
Implemented in DocuSign.eSign.Api.BillingApi.
◆ GetInvoiceAsync()
| System.Threading.Tasks.Task<BillingInvoice> DocuSign.eSign.Api.IBillingApi.GetInvoiceAsync | ( | string | accountId, |
| string | invoiceId | ||
| ) |
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 |
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. invoiceId
- Returns
- Task of BillingInvoice
Implemented in DocuSign.eSign.Api.BillingApi.
◆ GetInvoiceAsyncWithHttpInfo()
| System.Threading.Tasks.Task<ApiResponse<BillingInvoice> > DocuSign.eSign.Api.IBillingApi.GetInvoiceAsyncWithHttpInfo | ( | string | accountId, |
| string | invoiceId | ||
| ) |
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 |
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. invoiceId
- Returns
- Task of ApiResponse (BillingInvoice)
Implemented in DocuSign.eSign.Api.BillingApi.
◆ GetInvoiceWithHttpInfo()
| ApiResponse<BillingInvoice> DocuSign.eSign.Api.IBillingApi.GetInvoiceWithHttpInfo | ( | string | accountId, |
| string | invoiceId | ||
| ) |
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 |
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. invoiceId
- Returns
- ApiResponse of
Implemented in DocuSign.eSign.Api.BillingApi.
◆ GetPayment()
| BillingPaymentItem DocuSign.eSign.Api.IBillingApi.GetPayment | ( | string | accountId, |
| string | paymentId | ||
| ) |
Gets billing payment information for a specific payment.
Retrieves the information for a specified payment. Privileges required: account administrator
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. paymentId
- Returns
Implemented in DocuSign.eSign.Api.BillingApi.
◆ GetPaymentAsync()
| System.Threading.Tasks.Task<BillingPaymentItem> DocuSign.eSign.Api.IBillingApi.GetPaymentAsync | ( | string | accountId, |
| string | paymentId | ||
| ) |
Gets billing payment information for a specific payment.
Retrieves the information for a specified payment. Privileges required: account administrator
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. paymentId
- Returns
- Task of BillingPaymentItem
Implemented in DocuSign.eSign.Api.BillingApi.
◆ GetPaymentAsyncWithHttpInfo()
| System.Threading.Tasks.Task<ApiResponse<BillingPaymentItem> > DocuSign.eSign.Api.IBillingApi.GetPaymentAsyncWithHttpInfo | ( | string | accountId, |
| string | paymentId | ||
| ) |
Gets billing payment information for a specific payment.
Retrieves the information for a specified payment. Privileges required: account administrator
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. paymentId
- Returns
- Task of ApiResponse (BillingPaymentItem)
Implemented in DocuSign.eSign.Api.BillingApi.
◆ GetPaymentWithHttpInfo()
| ApiResponse<BillingPaymentItem> DocuSign.eSign.Api.IBillingApi.GetPaymentWithHttpInfo | ( | string | accountId, |
| string | paymentId | ||
| ) |
Gets billing payment information for a specific payment.
Retrieves the information for a specified payment. Privileges required: account administrator
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. paymentId
- Returns
- ApiResponse of
Implemented in DocuSign.eSign.Api.BillingApi.
◆ GetPlan()
| AccountBillingPlanResponse DocuSign.eSign.Api.IBillingApi.GetPlan | ( | string | accountId, |
| BillingApi.GetPlanOptions | options = null |
||
| ) |
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.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. options Options for modifying the behavior of the function.
- Returns
◆ GetPlanAsync()
| System.Threading.Tasks.Task<AccountBillingPlanResponse> DocuSign.eSign.Api.IBillingApi.GetPlanAsync | ( | string | accountId, |
| BillingApi.GetPlanOptions | options = null |
||
| ) |
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.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. options Options for modifying the behavior of the function.
- Returns
- Task of AccountBillingPlanResponse
◆ GetPlanAsyncWithHttpInfo()
| System.Threading.Tasks.Task<ApiResponse<AccountBillingPlanResponse> > DocuSign.eSign.Api.IBillingApi.GetPlanAsyncWithHttpInfo | ( | string | accountId, |
| BillingApi.GetPlanOptions | options = null |
||
| ) |
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.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (AccountBillingPlanResponse)
◆ GetPlanWithHttpInfo()
| ApiResponse<AccountBillingPlanResponse> DocuSign.eSign.Api.IBillingApi.GetPlanWithHttpInfo | ( | string | accountId, |
| BillingApi.GetPlanOptions | options = null |
||
| ) |
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.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. options Options for modifying the behavior of the function.
- Returns
- ApiResponse of
◆ ListBillingPlans()
| BillingPlansResponse DocuSign.eSign.Api.IBillingApi.ListBillingPlans | ( | ) |
Gets the list of available billing plans.
Retrieves a list of the billing plans associated with a distributor.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Returns
Implemented in DocuSign.eSign.Api.BillingApi.
◆ ListBillingPlansAsync()
| System.Threading.Tasks.Task<BillingPlansResponse> DocuSign.eSign.Api.IBillingApi.ListBillingPlansAsync | ( | ) |
Gets the list of available billing plans.
Retrieves a list of the billing plans associated with a distributor.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Returns
- Task of BillingPlansResponse
Implemented in DocuSign.eSign.Api.BillingApi.
◆ ListBillingPlansAsyncWithHttpInfo()
| System.Threading.Tasks.Task<ApiResponse<BillingPlansResponse> > DocuSign.eSign.Api.IBillingApi.ListBillingPlansAsyncWithHttpInfo | ( | ) |
Gets the list of available billing plans.
Retrieves a list of the billing plans associated with a distributor.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Returns
- Task of ApiResponse (BillingPlansResponse)
Implemented in DocuSign.eSign.Api.BillingApi.
◆ ListBillingPlansWithHttpInfo()
| ApiResponse<BillingPlansResponse> DocuSign.eSign.Api.IBillingApi.ListBillingPlansWithHttpInfo | ( | ) |
Gets the list of available billing plans.
Retrieves a list of the billing plans associated with a distributor.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Returns
- ApiResponse of
Implemented in DocuSign.eSign.Api.BillingApi.
◆ ListInvoices()
| BillingInvoicesResponse DocuSign.eSign.Api.IBillingApi.ListInvoices | ( | string | accountId, |
| BillingApi.ListInvoicesOptions | options = null |
||
| ) |
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
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. options Options for modifying the behavior of the function.
- Returns
◆ ListInvoicesAsync()
| System.Threading.Tasks.Task<BillingInvoicesResponse> DocuSign.eSign.Api.IBillingApi.ListInvoicesAsync | ( | string | accountId, |
| BillingApi.ListInvoicesOptions | options = null |
||
| ) |
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
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. options Options for modifying the behavior of the function.
- Returns
- Task of BillingInvoicesResponse
◆ ListInvoicesAsyncWithHttpInfo()
| System.Threading.Tasks.Task<ApiResponse<BillingInvoicesResponse> > DocuSign.eSign.Api.IBillingApi.ListInvoicesAsyncWithHttpInfo | ( | string | accountId, |
| BillingApi.ListInvoicesOptions | options = null |
||
| ) |
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
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (BillingInvoicesResponse)
◆ ListInvoicesPastDue()
| BillingInvoicesSummary DocuSign.eSign.Api.IBillingApi.ListInvoicesPastDue | ( | string | accountId | ) |
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
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid.
- Returns
Implemented in DocuSign.eSign.Api.BillingApi.
◆ ListInvoicesPastDueAsync()
| System.Threading.Tasks.Task<BillingInvoicesSummary> DocuSign.eSign.Api.IBillingApi.ListInvoicesPastDueAsync | ( | string | accountId | ) |
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
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid.
- Returns
- Task of BillingInvoicesSummary
Implemented in DocuSign.eSign.Api.BillingApi.
◆ ListInvoicesPastDueAsyncWithHttpInfo()
| System.Threading.Tasks.Task<ApiResponse<BillingInvoicesSummary> > DocuSign.eSign.Api.IBillingApi.ListInvoicesPastDueAsyncWithHttpInfo | ( | string | accountId | ) |
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
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid.
- Returns
- Task of ApiResponse (BillingInvoicesSummary)
Implemented in DocuSign.eSign.Api.BillingApi.
◆ ListInvoicesPastDueWithHttpInfo()
| ApiResponse<BillingInvoicesSummary> DocuSign.eSign.Api.IBillingApi.ListInvoicesPastDueWithHttpInfo | ( | string | accountId | ) |
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
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid.
- Returns
- ApiResponse of
Implemented in DocuSign.eSign.Api.BillingApi.
◆ ListInvoicesWithHttpInfo()
| ApiResponse<BillingInvoicesResponse> DocuSign.eSign.Api.IBillingApi.ListInvoicesWithHttpInfo | ( | string | accountId, |
| BillingApi.ListInvoicesOptions | options = null |
||
| ) |
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
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. options Options for modifying the behavior of the function.
- Returns
- ApiResponse of
◆ ListPayments()
| BillingPaymentsResponse DocuSign.eSign.Api.IBillingApi.ListPayments | ( | string | accountId, |
| BillingApi.ListPaymentsOptions | options = null |
||
| ) |
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
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. options Options for modifying the behavior of the function.
- Returns
◆ ListPaymentsAsync()
| System.Threading.Tasks.Task<BillingPaymentsResponse> DocuSign.eSign.Api.IBillingApi.ListPaymentsAsync | ( | string | accountId, |
| BillingApi.ListPaymentsOptions | options = null |
||
| ) |
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
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. options Options for modifying the behavior of the function.
- Returns
- Task of BillingPaymentsResponse
◆ ListPaymentsAsyncWithHttpInfo()
| System.Threading.Tasks.Task<ApiResponse<BillingPaymentsResponse> > DocuSign.eSign.Api.IBillingApi.ListPaymentsAsyncWithHttpInfo | ( | string | accountId, |
| BillingApi.ListPaymentsOptions | options = null |
||
| ) |
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
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (BillingPaymentsResponse)
◆ ListPaymentsWithHttpInfo()
| ApiResponse<BillingPaymentsResponse> DocuSign.eSign.Api.IBillingApi.ListPaymentsWithHttpInfo | ( | string | accountId, |
| BillingApi.ListPaymentsOptions | options = null |
||
| ) |
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
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. options Options for modifying the behavior of the function.
- Returns
- ApiResponse of
◆ MakePayment()
| BillingPaymentResponse DocuSign.eSign.Api.IBillingApi.MakePayment | ( | string | accountId, |
| BillingPaymentRequest | billingPaymentRequest = null |
||
| ) |
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
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. billingPaymentRequest (optional)
- Returns
Implemented in DocuSign.eSign.Api.BillingApi.
◆ MakePaymentAsync()
| System.Threading.Tasks.Task<BillingPaymentResponse> DocuSign.eSign.Api.IBillingApi.MakePaymentAsync | ( | string | accountId, |
| BillingPaymentRequest | billingPaymentRequest = null |
||
| ) |
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
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. billingPaymentRequest (optional)
- Returns
- Task of BillingPaymentResponse
Implemented in DocuSign.eSign.Api.BillingApi.
◆ MakePaymentAsyncWithHttpInfo()
| System.Threading.Tasks.Task<ApiResponse<BillingPaymentResponse> > DocuSign.eSign.Api.IBillingApi.MakePaymentAsyncWithHttpInfo | ( | string | accountId, |
| BillingPaymentRequest | billingPaymentRequest = null |
||
| ) |
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
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. billingPaymentRequest (optional)
- Returns
- Task of ApiResponse (BillingPaymentResponse)
Implemented in DocuSign.eSign.Api.BillingApi.
◆ MakePaymentWithHttpInfo()
| ApiResponse<BillingPaymentResponse> DocuSign.eSign.Api.IBillingApi.MakePaymentWithHttpInfo | ( | string | accountId, |
| BillingPaymentRequest | billingPaymentRequest = null |
||
| ) |
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
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. billingPaymentRequest (optional)
- Returns
- ApiResponse of
Implemented in DocuSign.eSign.Api.BillingApi.
◆ PurchaseEnvelopes()
| void DocuSign.eSign.Api.IBillingApi.PurchaseEnvelopes | ( | string | accountId, |
| PurchasedEnvelopesInformation | purchasedEnvelopesInformation = null |
||
| ) |
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.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. purchasedEnvelopesInformation (optional)
- Returns
Implemented in DocuSign.eSign.Api.BillingApi.
◆ PurchaseEnvelopesAsync()
| System.Threading.Tasks.Task DocuSign.eSign.Api.IBillingApi.PurchaseEnvelopesAsync | ( | string | accountId, |
| PurchasedEnvelopesInformation | purchasedEnvelopesInformation = null |
||
| ) |
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.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. purchasedEnvelopesInformation (optional)
- Returns
- Task of void
Implemented in DocuSign.eSign.Api.BillingApi.
◆ PurchaseEnvelopesAsyncWithHttpInfo()
| System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IBillingApi.PurchaseEnvelopesAsyncWithHttpInfo | ( | string | accountId, |
| PurchasedEnvelopesInformation | purchasedEnvelopesInformation = null |
||
| ) |
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.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. purchasedEnvelopesInformation (optional)
- Returns
- Task of ApiResponse
Implemented in DocuSign.eSign.Api.BillingApi.
◆ PurchaseEnvelopesWithHttpInfo()
| ApiResponse<Object> DocuSign.eSign.Api.IBillingApi.PurchaseEnvelopesWithHttpInfo | ( | string | accountId, |
| PurchasedEnvelopesInformation | purchasedEnvelopesInformation = null |
||
| ) |
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.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. purchasedEnvelopesInformation (optional)
- Returns
- ApiResponse of Object(void)
Implemented in DocuSign.eSign.Api.BillingApi.
◆ UpdateDowngradeAccountBillingPlan()
| DowngradePlanUpdateResponse DocuSign.eSign.Api.IBillingApi.UpdateDowngradeAccountBillingPlan | ( | string | accountId, |
| DowngradeBillingPlanInformation | downgradeBillingPlanInformation = null |
||
| ) |
Queues downgrade billing plan request for an account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. downgradeBillingPlanInformation (optional)
- Returns
Implemented in DocuSign.eSign.Api.BillingApi.
◆ UpdateDowngradeAccountBillingPlanAsync()
| System.Threading.Tasks.Task<DowngradePlanUpdateResponse> DocuSign.eSign.Api.IBillingApi.UpdateDowngradeAccountBillingPlanAsync | ( | string | accountId, |
| DowngradeBillingPlanInformation | downgradeBillingPlanInformation = null |
||
| ) |
Queues downgrade billing plan request for an account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. downgradeBillingPlanInformation (optional)
- Returns
- Task of DowngradePlanUpdateResponse
Implemented in DocuSign.eSign.Api.BillingApi.
◆ UpdateDowngradeAccountBillingPlanAsyncWithHttpInfo()
| System.Threading.Tasks.Task<ApiResponse<DowngradePlanUpdateResponse> > DocuSign.eSign.Api.IBillingApi.UpdateDowngradeAccountBillingPlanAsyncWithHttpInfo | ( | string | accountId, |
| DowngradeBillingPlanInformation | downgradeBillingPlanInformation = null |
||
| ) |
Queues downgrade billing plan request for an account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. downgradeBillingPlanInformation (optional)
- Returns
- Task of ApiResponse (DowngradePlanUpdateResponse)
Implemented in DocuSign.eSign.Api.BillingApi.
◆ UpdateDowngradeAccountBillingPlanWithHttpInfo()
| ApiResponse<DowngradePlanUpdateResponse> DocuSign.eSign.Api.IBillingApi.UpdateDowngradeAccountBillingPlanWithHttpInfo | ( | string | accountId, |
| DowngradeBillingPlanInformation | downgradeBillingPlanInformation = null |
||
| ) |
Queues downgrade billing plan request for an account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. downgradeBillingPlanInformation (optional)
- Returns
- ApiResponse of
Implemented in DocuSign.eSign.Api.BillingApi.
◆ UpdatePlan()
| BillingPlanUpdateResponse DocuSign.eSign.Api.IBillingApi.UpdatePlan | ( | string | accountId, |
| BillingPlanInformation | billingPlanInformation = null, |
||
| BillingApi.UpdatePlanOptions | options = null |
||
| ) |
Updates the account billing plan.
Updates the billing plan information, billing address, and credit card information for the specified account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. billingPlanInformation (optional) options Options for modifying the behavior of the function.
- Returns
◆ UpdatePlanAsync()
| System.Threading.Tasks.Task<BillingPlanUpdateResponse> DocuSign.eSign.Api.IBillingApi.UpdatePlanAsync | ( | string | accountId, |
| BillingPlanInformation | billingPlanInformation = null, |
||
| BillingApi.UpdatePlanOptions | options = null |
||
| ) |
Updates the account billing plan.
Updates the billing plan information, billing address, and credit card information for the specified account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. billingPlanInformation (optional) options Options for modifying the behavior of the function.
- Returns
- Task of BillingPlanUpdateResponse
◆ UpdatePlanAsyncWithHttpInfo()
| System.Threading.Tasks.Task<ApiResponse<BillingPlanUpdateResponse> > DocuSign.eSign.Api.IBillingApi.UpdatePlanAsyncWithHttpInfo | ( | string | accountId, |
| BillingPlanInformation | billingPlanInformation = null, |
||
| BillingApi.UpdatePlanOptions | options = null |
||
| ) |
Updates the account billing plan.
Updates the billing plan information, billing address, and credit card information for the specified account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. billingPlanInformation (optional) options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (BillingPlanUpdateResponse)
◆ UpdatePlanWithHttpInfo()
| ApiResponse<BillingPlanUpdateResponse> DocuSign.eSign.Api.IBillingApi.UpdatePlanWithHttpInfo | ( | string | accountId, |
| BillingPlanInformation | billingPlanInformation = null, |
||
| BillingApi.UpdatePlanOptions | options = null |
||
| ) |
Updates the account billing plan.
Updates the billing plan information, billing address, and credit card information for the specified account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. billingPlanInformation (optional) options Options for modifying the behavior of the function.
- Returns
- ApiResponse of
The documentation for this interface was generated from the following file:
- sdk/src/DocuSign.eSign/Api/BillingApi.cs
