DocuSign.Api.BillingPlans.billing_plan_get_billing_plan

You're seeing just the function billing_plan_get_billing_plan, go back to DocuSign.Api.BillingPlans module for more information.
Link to this function

billing_plan_get_billing_plan(connection, account_id, opts \\ [])

View Source

Specs

billing_plan_get_billing_plan(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.BillingPlans.t()} | {:error, Tesla.Env.t()}

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

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :include_credit_card_information (String.t): When set to true, payment information including credit card information will show in the return.
    • :include_metadata (String.t): 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_plans (String.t): When set to true, excludes successor information from the response.

Returns

} on success {:error, info} on failure