{"api":"esign_rest","category":"reference"}

BillingPlans Resource

The Billing resource provides methods that allow you to manage the billing plans,associated with an account.

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.