Represents a collection of functions to interact with the API endpoints More...
Classes | |
| class | GetPlanOptions |
| 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. More... | |
| class | ListInvoicesOptions |
| 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 More... | |
| class | ListPaymentsOptions |
| 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 More... | |
| class | UpdatePlanOptions |
| Updates the account billing plan. Updates the billing plan information, billing address, and credit card information for the specified account. More... | |
Public Member Functions | |
| BillingApi (DocuSignClient aplClient) | |
| Initializes a new instance of the BillingApi class using AplClient object More... | |
| String | GetBasePath () |
| Gets the base path of the API client. More... | |
| BillingPlanResponse | GetBillingPlan (string billingPlanId) |
| Get the billing plan details. Retrieves the billing plan details for the specified billing plan ID. More... | |
| ApiResponse< BillingPlanResponse > | GetBillingPlanWithHttpInfo (string billingPlanId) |
| Get the billing plan details. Retrieves the billing plan details for the specified billing plan ID. More... | |
| async System.Threading.Tasks.Task< BillingPlanResponse > | GetBillingPlanAsync (string billingPlanId) |
| Get the billing plan details. Retrieves the billing plan details for the specified billing plan ID. More... | |
| async System.Threading.Tasks.Task< ApiResponse< BillingPlanResponse > > | GetBillingPlanAsyncWithHttpInfo (string billingPlanId) |
| Get the billing plan details. Retrieves the billing plan details for the specified billing plan ID. More... | |
| CreditCardInformation | GetCreditCardInfo (string accountId) |
| Get metadata for a given credit card. This method returns information about a credit card associated with an account. More... | |
| ApiResponse< CreditCardInformation > | GetCreditCardInfoWithHttpInfo (string accountId) |
| Get metadata for a given credit card. This method returns information about a credit card associated with an account. More... | |
| async System.Threading.Tasks.Task< CreditCardInformation > | GetCreditCardInfoAsync (string accountId) |
| Get metadata for a given credit card. This method returns information about a credit card associated with an account. More... | |
| async System.Threading.Tasks.Task< ApiResponse< CreditCardInformation > > | GetCreditCardInfoAsyncWithHttpInfo (string accountId) |
| Get metadata for a given credit card. This method returns information about a credit card associated with an account. 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... | |
| async System.Threading.Tasks.Task< DowngradRequestBillingInfoResponse > | GetDowngradeRequestBillingInfoAsync (string accountId) |
| Returns downgrade plan information for the specified account. More... | |
| async System.Threading.Tasks.Task< ApiResponse< DowngradRequestBillingInfoResponse > > | GetDowngradeRequestBillingInfoAsyncWithHttpInfo (string accountId) |
| Returns downgrade plan information for the specified account. More... | |
| BillingInvoice | 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 | More... | |
| ApiResponse< BillingInvoice > | 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 | More... | |
| async System.Threading.Tasks.Task< BillingInvoice > | 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 | More... | |
| async System.Threading.Tasks.Task< ApiResponse< BillingInvoice > > | 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 | More... | |
| BillingPaymentItem | GetPayment (string accountId, string paymentId) |
| Gets billing payment information for a specific payment. Retrieves the information for a specified payment. Privileges required: account administrator More... | |
| ApiResponse< BillingPaymentItem > | GetPaymentWithHttpInfo (string accountId, string paymentId) |
| Gets billing payment information for a specific payment. Retrieves the information for a specified payment. Privileges required: account administrator More... | |
| async System.Threading.Tasks.Task< BillingPaymentItem > | GetPaymentAsync (string accountId, string paymentId) |
| Gets billing payment information for a specific payment. Retrieves the information for a specified payment. Privileges required: account administrator More... | |
| async System.Threading.Tasks.Task< ApiResponse< BillingPaymentItem > > | GetPaymentAsyncWithHttpInfo (string accountId, string paymentId) |
| Gets billing payment information for a specific payment. Retrieves the information for a specified payment. Privileges required: account administrator More... | |
| AccountBillingPlanResponse | 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. More... | |
| ApiResponse< AccountBillingPlanResponse > | 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. More... | |
| async System.Threading.Tasks.Task< AccountBillingPlanResponse > | 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. More... | |
| async System.Threading.Tasks.Task< ApiResponse< AccountBillingPlanResponse > > | 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. More... | |
| BillingPlansResponse | ListBillingPlans () |
| Gets the list of available billing plans. Retrieves a list of the billing plans associated with a distributor. More... | |
| ApiResponse< BillingPlansResponse > | ListBillingPlansWithHttpInfo () |
| Gets the list of available billing plans. Retrieves a list of the billing plans associated with a distributor. More... | |
| async System.Threading.Tasks.Task< BillingPlansResponse > | ListBillingPlansAsync () |
| Gets the list of available billing plans. Retrieves a list of the billing plans associated with a distributor. More... | |
| async System.Threading.Tasks.Task< ApiResponse< BillingPlansResponse > > | ListBillingPlansAsyncWithHttpInfo () |
| Gets the list of available billing plans. Retrieves a list of the billing plans associated with a distributor. More... | |
| BillingInvoicesResponse | 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 More... | |
| ApiResponse< BillingInvoicesResponse > | 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 More... | |
| async System.Threading.Tasks.Task< BillingInvoicesResponse > | 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 More... | |
| async System.Threading.Tasks.Task< ApiResponse< BillingInvoicesResponse > > | 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 More... | |
| BillingInvoicesSummary | 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 More... | |
| ApiResponse< BillingInvoicesSummary > | 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 More... | |
| async System.Threading.Tasks.Task< BillingInvoicesSummary > | 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 More... | |
| async System.Threading.Tasks.Task< ApiResponse< BillingInvoicesSummary > > | 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 More... | |
| BillingPaymentsResponse | 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 More... | |
| ApiResponse< BillingPaymentsResponse > | 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 More... | |
| async System.Threading.Tasks.Task< BillingPaymentsResponse > | 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 More... | |
| async System.Threading.Tasks.Task< ApiResponse< BillingPaymentsResponse > > | 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 More... | |
| BillingPaymentResponse | 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 More... | |
| ApiResponse< BillingPaymentResponse > | 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 More... | |
| async System.Threading.Tasks.Task< BillingPaymentResponse > | 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 More... | |
| async System.Threading.Tasks.Task< ApiResponse< BillingPaymentResponse > > | 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 More... | |
| void | 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. More... | |
| ApiResponse< Object > | 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. More... | |
| async System.Threading.Tasks.Task | 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. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Object > > | 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. 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... | |
| async System.Threading.Tasks.Task< DowngradePlanUpdateResponse > | UpdateDowngradeAccountBillingPlanAsync (string accountId, DowngradeBillingPlanInformation downgradeBillingPlanInformation=null) |
| Queues downgrade billing plan request for an account. More... | |
| async System.Threading.Tasks.Task< ApiResponse< DowngradePlanUpdateResponse > > | UpdateDowngradeAccountBillingPlanAsyncWithHttpInfo (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. Updates the billing plan information, billing address, and credit card information for the specified account. More... | |
| ApiResponse< BillingPlanUpdateResponse > | 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. More... | |
| async System.Threading.Tasks.Task< BillingPlanUpdateResponse > | 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. More... | |
| async System.Threading.Tasks.Task< ApiResponse< BillingPlanUpdateResponse > > | 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. More... | |
 Public Member Functions inherited from DocuSign.eSign.Api.IBillingApi | |
| 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... | |
| 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... | |
| 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... | |
| 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< 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< 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< 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< 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... | |
Properties | |
| DocuSignClient | ApiClient [get, set] |
| Gets or sets the ApiClient object More... | |
| DocuSign.eSign.Client.ExceptionFactory | ExceptionFactory [get, set] |
| Provides a factory method hook for the creation of exceptions. More... | |
| 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
Constructor & Destructor Documentation
◆ BillingApi()
|
inline |
Initializes a new instance of the BillingApi class using AplClient object
- Parameters
-
aplClient An instance of AplClient
- Returns
Member Function Documentation
◆ GetBasePath()
|
inline |
◆ GetBillingPlan()
|
inline |
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
- BillingPlanResponse
Implements DocuSign.eSign.Api.IBillingApi.
◆ GetBillingPlanAsync()
|
inline |
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
Implements DocuSign.eSign.Api.IBillingApi.
◆ GetBillingPlanAsyncWithHttpInfo()
|
inline |
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)
Implements DocuSign.eSign.Api.IBillingApi.
◆ GetBillingPlanWithHttpInfo()
|
inline |
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 BillingPlanResponse
Implements DocuSign.eSign.Api.IBillingApi.
◆ GetCreditCardInfo()
|
inline |
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
- CreditCardInformation
Implements DocuSign.eSign.Api.IBillingApi.
◆ GetCreditCardInfoAsync()
|
inline |
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
Implements DocuSign.eSign.Api.IBillingApi.
◆ GetCreditCardInfoAsyncWithHttpInfo()
|
inline |
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)
Implements DocuSign.eSign.Api.IBillingApi.
◆ GetCreditCardInfoWithHttpInfo()
|
inline |
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 CreditCardInformation
Implements DocuSign.eSign.Api.IBillingApi.
◆ GetDowngradeRequestBillingInfo()
|
inline |
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
- DowngradRequestBillingInfoResponse
Implements DocuSign.eSign.Api.IBillingApi.
◆ GetDowngradeRequestBillingInfoAsync()
|
inline |
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
Implements DocuSign.eSign.Api.IBillingApi.
◆ GetDowngradeRequestBillingInfoAsyncWithHttpInfo()
|
inline |
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)
Implements DocuSign.eSign.Api.IBillingApi.
◆ GetDowngradeRequestBillingInfoWithHttpInfo()
|
inline |
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 DowngradRequestBillingInfoResponse
Implements DocuSign.eSign.Api.IBillingApi.
◆ GetInvoice()
|
inline |
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
- BillingInvoice
Implements DocuSign.eSign.Api.IBillingApi.
◆ GetInvoiceAsync()
|
inline |
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
Implements DocuSign.eSign.Api.IBillingApi.
◆ GetInvoiceAsyncWithHttpInfo()
|
inline |
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)
Implements DocuSign.eSign.Api.IBillingApi.
◆ GetInvoiceWithHttpInfo()
|
inline |
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 BillingInvoice
Implements DocuSign.eSign.Api.IBillingApi.
◆ GetPayment()
|
inline |
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
- BillingPaymentItem
Implements DocuSign.eSign.Api.IBillingApi.
◆ GetPaymentAsync()
|
inline |
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
Implements DocuSign.eSign.Api.IBillingApi.
◆ GetPaymentAsyncWithHttpInfo()
|
inline |
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)
Implements DocuSign.eSign.Api.IBillingApi.
◆ GetPaymentWithHttpInfo()
|
inline |
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 BillingPaymentItem
Implements DocuSign.eSign.Api.IBillingApi.
◆ GetPlan()
|
inline |
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
- AccountBillingPlanResponse
◆ GetPlanAsync()
|
inline |
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()
|
inline |
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()
|
inline |
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 AccountBillingPlanResponse
◆ ListBillingPlans()
|
inline |
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
- BillingPlansResponse
Implements DocuSign.eSign.Api.IBillingApi.
◆ ListBillingPlansAsync()
|
inline |
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
Implements DocuSign.eSign.Api.IBillingApi.
◆ ListBillingPlansAsyncWithHttpInfo()
|
inline |
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)
Implements DocuSign.eSign.Api.IBillingApi.
◆ ListBillingPlansWithHttpInfo()
|
inline |
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 BillingPlansResponse
Implements DocuSign.eSign.Api.IBillingApi.
◆ ListInvoices()
|
inline |
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
- BillingInvoicesResponse
◆ ListInvoicesAsync()
|
inline |
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()
|
inline |
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()
|
inline |
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
- BillingInvoicesSummary
Implements DocuSign.eSign.Api.IBillingApi.
◆ ListInvoicesPastDueAsync()
|
inline |
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
Implements DocuSign.eSign.Api.IBillingApi.
◆ ListInvoicesPastDueAsyncWithHttpInfo()
|
inline |
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)
Implements DocuSign.eSign.Api.IBillingApi.
◆ ListInvoicesPastDueWithHttpInfo()
|
inline |
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 BillingInvoicesSummary
Implements DocuSign.eSign.Api.IBillingApi.
◆ ListInvoicesWithHttpInfo()
|
inline |
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 BillingInvoicesResponse
◆ ListPayments()
|
inline |
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
- BillingPaymentsResponse
◆ ListPaymentsAsync()
|
inline |
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()
|
inline |
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()
|
inline |
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 BillingPaymentsResponse
◆ MakePayment()
|
inline |
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
- BillingPaymentResponse
Implements DocuSign.eSign.Api.IBillingApi.
◆ MakePaymentAsync()
|
inline |
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
Implements DocuSign.eSign.Api.IBillingApi.
◆ MakePaymentAsyncWithHttpInfo()
|
inline |
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)
Implements DocuSign.eSign.Api.IBillingApi.
◆ MakePaymentWithHttpInfo()
|
inline |
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 BillingPaymentResponse
Implements DocuSign.eSign.Api.IBillingApi.
◆ PurchaseEnvelopes()
|
inline |
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
Implements DocuSign.eSign.Api.IBillingApi.
◆ PurchaseEnvelopesAsync()
|
inline |
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
Implements DocuSign.eSign.Api.IBillingApi.
◆ PurchaseEnvelopesAsyncWithHttpInfo()
|
inline |
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
Implements DocuSign.eSign.Api.IBillingApi.
◆ PurchaseEnvelopesWithHttpInfo()
|
inline |
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)
Implements DocuSign.eSign.Api.IBillingApi.
◆ UpdateDowngradeAccountBillingPlan()
|
inline |
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
- DowngradePlanUpdateResponse
Implements DocuSign.eSign.Api.IBillingApi.
◆ UpdateDowngradeAccountBillingPlanAsync()
|
inline |
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
Implements DocuSign.eSign.Api.IBillingApi.
◆ UpdateDowngradeAccountBillingPlanAsyncWithHttpInfo()
|
inline |
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)
Implements DocuSign.eSign.Api.IBillingApi.
◆ UpdateDowngradeAccountBillingPlanWithHttpInfo()
|
inline |
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 DowngradePlanUpdateResponse
Implements DocuSign.eSign.Api.IBillingApi.
◆ UpdatePlan()
|
inline |
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
- BillingPlanUpdateResponse
◆ UpdatePlanAsync()
|
inline |
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()
|
inline |
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()
|
inline |
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 BillingPlanUpdateResponse
Property Documentation
◆ ApiClient
|
getset |
Gets or sets the ApiClient object
An instance of the ApiClient
◆ ExceptionFactory
|
getset |
Provides a factory method hook for the creation of exceptions.
The documentation for this class was generated from the following file:
- sdk/src/DocuSign.eSign/Api/BillingApi.cs
