Method: DocuSign_eSign::BillingApi#get_plan

Defined in:
lib/docusign_esign/api/billing_api.rb

#get_plan(account_id, options = DocuSign_eSign::GetPlanOptions.default) ⇒ AccountBillingPlanResponse

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:

  • account_id —

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

  • DocuSign_eSign::GetPlanOptions —

    Options for modifying the behavior of the function.

Returns:



331
332
333
334
 
# File 'lib/docusign_esign/api/billing_api.rb', line 331

def get_plan(, options = DocuSign_eSign::GetPlanOptions.default)
  data, _status_code, _headers = get_plan_with_http_info(, options)
  return data
end