DocuSign Momentum 2018DocuSign Momentum 2018
{"api":"esign_rest","category":"reference"}

Billing Category

Use the Billing category to manage the following billing related tasks:

  • Retrieve and update billing plan information.
  • Retrieve invoices.
  • Retrieve and update payment information.

BillingPlans

Billing plans

MethodDescription
getAccountPlan
GET /v2/accounts/{accountId}/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.

update
PUT /v2/accounts/{accountId}/billing_plan

Updates the billing plan information, billing address, and credit card information for the specified account.

getCreditCard
GET /v2/accounts/{accountId}/billing_plan/credit_card

purchaseEnvelopes
PUT /v2/accounts/{accountId}/billing_plan/purchased_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.

list
GET /v2/billing_plans

Retrieves a list of the billing plans associated with a distributor.

get
GET /v2/billing_plans/{billingPlanId}

Retrieves the billing plan details for the specified billing plan ID.

Invoices

Invoices

MethodDescription
list
GET /v2/accounts/{accountId}/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

get
GET /v2/accounts/{accountId}/billing_invoices/{invoiceId}

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

listPastDue
GET /v2/accounts/{accountId}/billing_invoices_past_due

Returns a list past due invoices for the account and notes if payment can be made through the REST API.

Privileges Required: account administrator

Payments

Payments

MethodDescription
list
GET /v2/accounts/{accountId}/billing_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

create
POST /v2/accounts/{accountId}/billing_payments

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

get
GET /v2/accounts/{accountId}/billing_payments/{paymentId}

Retrieves the information for a specified payment.

Privileges required: account administrator