Accounts: getBillingCharges

Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items.

Privileges required: account administrator

Request

HTTP request

GET /v2.1/accounts/{accountId}/billing_charges

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

Optional Query Parameters
include_chargesstring

Specifies which billing charges to return. Valid values are:

  • envelopes
  • seats

Responses

CodeDescriptionReference
200

Successful response.

billingChargeResponse
400

Error encountered.

errorDetails

SDK Method

Accounts::getBillingCharges

Definitions

billingCharge

Contains information about a billing charge.

allowedQuantitystring

Reserved: TBD

blockedstring

Reserved: TBD

chargeNamestring

Provides information on what services the charge item is for.

The following table provides a description of the different chargeName values available at this time.

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

chargeTypestring

Reserved: TBD

chargeUnitOfMeasurestring

Reserved: TBD

discounts[billingDiscount]

firstEffectiveDatestring

includedQuantitystring

incrementalQuantitystring

Reserved: TBD

lastEffectiveDatestring

prices[billingPrice]

unitPricestring

Reserved: TBD

usedQuantitystring

billingChargeResponse

Defines a billing charge response object.

billingChargeItems[billingCharge]

Reserved: TBD

billingDiscount

beginQuantitystring

Reserved: TBD

discountstring

endQuantitystring

billingPrice

beginQuantitystring

Reserved: TBD

endQuantitystring

unitPricestring

Reserved: TBD

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

Examples

Generic JSON Response

Response
{
  "billingChargeItems": [
    {
      "chargeName": "sample string 1",
      "chargeType": "sample string 2",
      "chargeUnitOfMeasure": "sample string 3",
      "allowedQuantity": "sample string 4",
      "usedQuantity": "sample string 5",
      "includedQuantity": "sample string 6",
      "incrementalQuantity": "sample string 7",
      "firstEffectiveDate": "sample string 8",
      "lastEffectiveDate": "sample string 9",
      "unitPrice": "sample string 10",
      "blocked": "sample string 11",
      "prices": [
        {
          "unitPrice": "sample string 1",
          "beginQuantity": "sample string 2",
          "endQuantity": "sample string 3"
        }
      ],
      "discounts": [
        {
          "endQuantity": "sample string 1",
          "beginQuantity": "sample string 2",
          "discount": "sample string 3"
        }
      ]
    }
  ]
}
Generic XML Response

Response
<billingChargeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <billingChargeItems>
    <billingCharge>
      <allowedQuantity>sample string 4</allowedQuantity>
      <blocked>sample string 11</blocked>
      <chargeName>sample string 1</chargeName>
      <chargeType>sample string 2</chargeType>
      <chargeUnitOfMeasure>sample string 3</chargeUnitOfMeasure>
      <discounts>
        <billingDiscount>
          <beginQuantity>sample string 2</beginQuantity>
          <discount>sample string 3</discount>
          <endQuantity>sample string 1</endQuantity>
        </billingDiscount>
      </discounts>
      <firstEffectiveDate>sample string 8</firstEffectiveDate>
      <includedQuantity>sample string 6</includedQuantity>
      <incrementalQuantity>sample string 7</incrementalQuantity>
      <lastEffectiveDate>sample string 9</lastEffectiveDate>
      <prices>
        <billingPrice>
          <beginQuantity>sample string 2</beginQuantity>
          <endQuantity>sample string 3</endQuantity>
          <unitPrice>sample string 1</unitPrice>
        </billingPrice>
      </prices>
      <unitPrice>sample string 10</unitPrice>
      <usedQuantity>sample string 5</usedQuantity>
    </billingCharge>
  </billingChargeItems>
</billingChargeResponse> 
}} />