new module:api/BillingApi(apiClient)
- Source:
Constructs a new BillingApi.
Parameters:
Name | Type | Description |
---|---|---|
apiClient |
module:ApiClient | Optional API client implementation to use, |
Methods
getBillingPlan(billingPlanId, callback)
- Source:
Get the billing plan details.
Retrieves the billing plan details for the specified billing plan ID.
Parameters:
Name | Type | Description |
---|---|---|
billingPlanId |
String | The ID of the billing plan being accessed. |
callback |
module:api/BillingApi~getBillingPlanCallback | The callback function, accepting three arguments: error, data, response |
getCreditCardInfo(accountId, callback)
- Source:
Get metadata for a given credit card.
This method returns information about a credit card associated with an account.
Parameters:
Name | Type | Description |
---|---|---|
accountId |
String | The external account number (int) or account ID Guid. |
callback |
module:api/BillingApi~getCreditCardInfoCallback | The callback function, accepting three arguments: error, data, response |
getDowngradeRequestBillingInfo(accountId, callback)
- Source:
Returns downgrade plan information for the specified account.
Parameters:
Name | Type | Description |
---|---|---|
accountId |
String | The external account number (int) or account ID Guid. |
callback |
module:api/BillingApi~getDowngradeRequestBillingInfoCallback | The callback function, accepting three arguments: error, data, response |
getInvoice(accountId, invoiceId, callback)
- Source:
Retrieves a billing invoice.
Retrieves the specified invoice.
Note: If the pdfAvailable
property in the response is set to true, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the Accept
property in the header to Accept: application/pdf
.
Privileges required: account administrator
The response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account.
Response*
The following table provides a description of the different chargeName
property values. The information will grow as more chargeable items are added to the system.
chargeName | Description |
---|---|
id_check | ID Check Charge |
in_person_signing | In Person Signing charge |
envelopes Included | Sent Envelopes for the account |
age_verify | Age verification check |
ofac | OFAC Check |
id_confirm | ID confirmation check |
student_authentication | STAN PIN authentication check |
wet_sign_fax | Pages for returning signed documents by fax |
attachment_fax | Pages for returning attachments by fax |
phone_authentication | Phone authentication charge |
powerforms | PowerForm envelopes sent |
signer_payments | Payment processing charge |
outbound_fax | Send by fax charge |
bulk_recipient_envelopes | Bulk Recipient Envelopes sent |
sms_authentications | SMS authentication charge |
saml_authentications | SAML authentication charge |
express_signer_certificate | DocuSign Express Certificate charge |
personal_signer_certificate | Personal Signer Certificate charge |
safe_certificate | SAFE BioPharma Signer Certificate charge |
seats | Included active seats charge |
open_trust_certificate | OpenTrust Signer Certificate charge |
Parameters:
Name | Type | Description |
---|---|---|
accountId |
String | The external account number (int) or account ID Guid. |
invoiceId |
String | |
callback |
module:api/BillingApi~getInvoiceCallback | The callback function, accepting three arguments: error, data, response |
getPayment(accountId, paymentId, callback)
- Source:
Gets billing payment information for a specific payment.
Retrieves the information for a specified payment.
Privileges required: account administrator
Parameters:
Name | Type | Description |
---|---|---|
accountId |
String | The external account number (int) or account ID Guid. |
paymentId |
String | |
callback |
module:api/BillingApi~getPaymentCallback | The callback function, accepting three arguments: error, data, response |
getPlan(accountId, optsOrCallback, callback)
- Source:
Get Account Billing Plan
Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card.
By default the successor plan and credit card information is included in the response. This information can be excluded from the response by adding the appropriate optional query string with the setting
set to false.
Response
The response returns the billing plan information, including the currency code, for the plan. The billingPlan
and succesorPlans
property values are the same as those shown in the [ML:Get Billing Plan Details] reference. the billingAddress
and creditCardInformation
property values are the same as those shown in the [ML:Update Billing Plan] reference.
Note: When credit card number information is shown, a mask is applied to the response so that only the last 4 digits of the card number are visible.
Parameters:
Name | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
accountId |
String | The external account number (int) or account ID Guid. |
||||||||||||||||||
optsOrCallback |
Object | Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely. Properties
|
||||||||||||||||||
callback |
module:api/BillingApi~getPlanCallback | The callback function, accepting three arguments: error, data, response |
listBillingPlans(callback)
- Source:
Gets the list of available billing plans.
Retrieves a list of the billing plans associated with a distributor.
Parameters:
Name | Type | Description |
---|---|---|
callback |
module:api/BillingApi~listBillingPlansCallback | The callback function, accepting three arguments: error, data, response |
listInvoices(accountId, optsOrCallback, callback)
- Source:
Get a List of Billing Invoices
Retrieves a list of invoices for the account. If the from date or to date queries are not specified, the response returns invoices for the last 365 days.
Privileges required: account administrator
Parameters:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
accountId |
String | The external account number (int) or account ID Guid. |
|||||||||
optsOrCallback |
Object | Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely. Properties
|
|||||||||
callback |
module:api/BillingApi~listInvoicesCallback | The callback function, accepting three arguments: error, data, response |
listInvoicesPastDue(accountId, callback)
- Source:
Get a list of past due invoices.
Returns a list past due invoices for the account and notes if payment can be made through the REST API.
Privileges Required: account administrator
Parameters:
Name | Type | Description |
---|---|---|
accountId |
String | The external account number (int) or account ID Guid. |
callback |
module:api/BillingApi~listInvoicesPastDueCallback | The callback function, accepting three arguments: error, data, response |
listPayments(accountId, optsOrCallback, callback)
- Source:
Gets payment information for one or more payments.
Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days.
Privileges required: account administrator
Parameters:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
accountId |
String | The external account number (int) or account ID Guid. |
|||||||||
optsOrCallback |
Object | Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely. Properties
|
|||||||||
callback |
module:api/BillingApi~listPaymentsCallback | The callback function, accepting three arguments: error, data, response |
makePayment(accountId, optsOrCallback, callback)
- Source:
Posts a payment to a past due invoice.
Posts a payment to a past due invoice.
Note: This can only be used if the paymentAllowed
value for a past due invoice is true. This can be determined calling [ML:GetBillingInvoicesPastDue].
The response returns information for a single payment, if a payment ID was used in the endpoint, or a list of payments. If the from date or to date queries or payment ID are not used, the response returns payment information for the last 365 days. If the request was for a single payment ID, the nextUri
and previousUri
properties are not returned.
Privileges required: account administrator
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
accountId |
String | The external account number (int) or account ID Guid. |
||||||
optsOrCallback |
Object | Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely. Properties
|
||||||
callback |
module:api/BillingApi~makePaymentCallback | The callback function, accepting three arguments: error, data, response |
purchaseEnvelopes(accountId, optsOrCallback, callback)
- Source:
Reserverd: Purchase additional envelopes.
Reserved: At this time, this endpoint is limited to DocuSign internal use only. Completes the purchase of envelopes for your account. The actual purchase is done as part of an internal workflow interaction with an envelope vendor.
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
accountId |
String | The external account number (int) or account ID Guid. |
||||||
optsOrCallback |
Object | Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely. Properties
|
||||||
callback |
module:api/BillingApi~purchaseEnvelopesCallback | The callback function, accepting three arguments: error, data, response |
updateDowngradeAccountBillingPlan(accountId, optsOrCallback, callback)
- Source:
Queues downgrade billing plan request for an account.
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
accountId |
String | The external account number (int) or account ID Guid. |
||||||
optsOrCallback |
Object | Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely. Properties
|
||||||
callback |
module:api/BillingApi~updateDowngradeAccountBillingPlanCallback | The callback function, accepting three arguments: error, data, response |
updatePlan(accountId, optsOrCallback, callback)
- Source:
Updates the account billing plan.
Updates the billing plan information, billing address, and credit card information for the specified account.
Parameters:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
accountId |
String | The external account number (int) or account ID Guid. |
|||||||||
optsOrCallback |
Object | Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely. Properties
|
|||||||||
callback |
module:api/BillingApi~updatePlanCallback | The callback function, accepting three arguments: error, data, response |
Type Definitions
getBillingPlanCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the getBillingPlan operation. If none specified a Promise will be returned.
Parameters:
Name | Type | Description |
---|---|---|
error |
String | Error message, if any. |
data |
module:model/BillingPlanResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
getCreditCardInfoCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the getCreditCardInfo operation. If none specified a Promise will be returned.
Parameters:
Name | Type | Description |
---|---|---|
error |
String | Error message, if any. |
data |
module:model/CreditCardInformation | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
getDowngradeRequestBillingInfoCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the getDowngradeRequestBillingInfo operation. If none specified a Promise will be returned.
Parameters:
Name | Type | Description |
---|---|---|
error |
String | Error message, if any. |
data |
module:model/DowngradRequestBillingInfoResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
getInvoiceCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the getInvoice operation. If none specified a Promise will be returned.
Parameters:
Name | Type | Description |
---|---|---|
error |
String | Error message, if any. |
data |
module:model/BillingInvoice | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
getPaymentCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the getPayment operation. If none specified a Promise will be returned.
Parameters:
Name | Type | Description |
---|---|---|
error |
String | Error message, if any. |
data |
module:model/BillingPaymentItem | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
getPlanCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the getPlan operation. If none specified a Promise will be returned.
Parameters:
Name | Type | Description |
---|---|---|
error |
String | Error message, if any. |
data |
module:model/AccountBillingPlanResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
listBillingPlansCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the listBillingPlans operation. If none specified a Promise will be returned.
Parameters:
Name | Type | Description |
---|---|---|
error |
String | Error message, if any. |
data |
module:model/BillingPlansResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
listInvoicesCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the listInvoices operation. If none specified a Promise will be returned.
Parameters:
Name | Type | Description |
---|---|---|
error |
String | Error message, if any. |
data |
module:model/BillingInvoicesResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
listInvoicesPastDueCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the listInvoicesPastDue operation. If none specified a Promise will be returned.
Parameters:
Name | Type | Description |
---|---|---|
error |
String | Error message, if any. |
data |
module:model/BillingInvoicesSummary | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
listPaymentsCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the listPayments operation. If none specified a Promise will be returned.
Parameters:
Name | Type | Description |
---|---|---|
error |
String | Error message, if any. |
data |
module:model/BillingPaymentsResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
makePaymentCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the makePayment operation. If none specified a Promise will be returned.
Parameters:
Name | Type | Description |
---|---|---|
error |
String | Error message, if any. |
data |
module:model/BillingPaymentResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
purchaseEnvelopesCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the purchaseEnvelopes operation. If none specified a Promise will be returned.
Parameters:
Name | Type | Description |
---|---|---|
error |
String | Error message, if any. |
data |
This operation does not return a value. |
|
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
updateDowngradeAccountBillingPlanCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the updateDowngradeAccountBillingPlan operation. If none specified a Promise will be returned.
Parameters:
Name | Type | Description |
---|---|---|
error |
String | Error message, if any. |
data |
module:model/DowngradePlanUpdateResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |
updatePlanCallback(error, data, If)
- Source:
(Optional) Callback function to receive the result of the updatePlan operation. If none specified a Promise will be returned.
Parameters:
Name | Type | Description |
---|---|---|
error |
String | Error message, if any. |
data |
module:model/BillingPlanUpdateResponse | The data returned by the service call. |
If |
String | a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data. |