DocuSign.Api.BillingPlans (DocuSign v0.3.3) View Source

API calls for all endpoints tagged BillingPlans.

Link to this section Summary

Functions

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.

Updates the account billing plan. Updates the billing plan information, billing address, and credit card information for the specified account.

Get the billing plan details. Retrieves the billing plan details for the specified billing plan ID.

Gets the list of available billing plans. Retrieves a list of the billing plans associated with a distributor.

Reserverd: Purchase additional 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.

Link to this section Functions

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

Link to this function

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

View Source

Specs

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

Get metadata for a given credit card.

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

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Updates the account billing plan. Updates the billing plan information, billing address, and credit card information for the specified account.

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
    • :preview_billing_plan (String.t): When set to true, updates the account using a preview billing plan.
    • :billing_plan_information (BillingPlanInformation):

Returns

} on success {:error, info} on failure

Link to this function

billing_plans_get_billing_plan(connection, billing_plan_id, opts \\ [])

View Source

Specs

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

Get the billing plan details. Retrieves the billing plan details for the specified billing plan ID.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • billing_plan_id (String.t): The ID of the billing plan being accessed.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

billing_plans_get_billing_plans(connection, opts \\ [])

View Source

Specs

billing_plans_get_billing_plans(Tesla.Env.client(), keyword()) ::
  {:ok, DocuSign.Model.BillingPlansResponse.t()} | {:error, Tesla.Env.t()}

Gets the list of available billing plans. Retrieves a list of the billing plans associated with a distributor.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

purchased_envelopes_put_purchased_envelopes(
  Tesla.Env.client(),
  String.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Reserverd: Purchase additional 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.

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
    • :purchased_envelopes_information (PurchasedEnvelopesInformation):

Returns

} on success {:error, info} on failure