DocuSign Momentum 2018DocuSign Momentum 2018

BillingPlans: getAccountPlan

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.

Request

HTTP request

GET /v2/accounts/{accountId}/billing_plan

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Optional Query Parameters
include_credit_card_informationstring

When set to true, excludes credit card information from the response.

include_metadatastring

When set to true, the canUpgrade and renewalStatus properities are included the response and an array of supportedCountries property is added to the billingAddress information.

include_successor_plansstring

When set to true, excludes successor information from the response.

Responses

CodeDescriptionReference
200

Successful response.

BillingPlans
400

Error encountered.

errorDetails

SDK Method

Billing::getPlan

Definitions

accountAddress
accountBillingPlan
addOn
addressInformation
appStoreProduct
billingPlan
country
creditCardInformation
creditCardTypes
currencyFeatureSetPrice
currencyPlanPrice
errorDetails
featureSet
paymentProcessorInformation
province
referralInformation
seatDiscount
BillingPlans

Examples

Generic JSON Response
Generic XML Response