View Source DocuSign.Api.BillingPlans (DocuSign v1.2.0)

API calls for all endpoints tagged BillingPlans.

Summary

Functions

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

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. You can exclude this information from the response by adding the appropriate optional query string and setting it 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 Billing: getBillingPlan reference. the billingAddress and creditCardInformation property values are the same as those shown in the Billing: updatePlan reference. Note: When credit card number information displays, a mask is applied to the response so that only the last 4 digits of the card number are visible.

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

Get credit card information This method returns information about a credit card associated with an account.

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

Returns downgrade plan information for the specified account.

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

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

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

Queues downgrade billing plan request for an account.

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

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

billing_plans_get_billing_plans(connection, opts \\ [])

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

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

Reserved: 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.

Functions

Link to this function

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

View Source 
@spec billing_plan_get_billing_plan(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.AccountBillingPlanResponse.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. You can exclude this information from the response by adding the appropriate optional query string and setting it 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 Billing: getBillingPlan reference. the billingAddress and creditCardInformation property values are the same as those shown in the Billing: updatePlan reference. Note: When credit card number information displays, 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 (keyword): Optional parameters
    • :include_credit_card_information (String.t): When true, payment information including credit card information will show in the return.
    • :include_downgrade_information (String.t):
    • :include_metadata (String.t): When true, the canUpgrade and renewalStatus properties are included the response and an array of supportedCountries is added to the billingAddress information.
    • :include_successor_plans (String.t): When true, excludes successor information from the response.
    • :include_tax_exempt_id (String.t):

Returns

  • {:ok, DocuSign.Model.AccountBillingPlanResponse.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

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

Get credit card information This method returns information about a credit card associated with an account.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • opts (keyword): Optional parameters

Returns

  • {:ok, DocuSign.Model.CreditCardInformation.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

View Source 
@spec billing_plan_get_downgrade_request_billing_info(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.DowngradRequestBillingInfoResponse.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Returns downgrade plan 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 (keyword): Optional parameters

Returns

  • {:ok, DocuSign.Model.DowngradRequestBillingInfoResponse.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

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

Updates an 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 (keyword): Optional parameters
    • :preview_billing_plan (String.t): When true, updates the account using a preview billing plan.
    • :body (BillingPlanInformation):

Returns

  • {:ok, DocuSign.Model.BillingPlanUpdateResponse.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

View Source 
@spec billing_plan_put_downgrade_account_billing_plan(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.DowngradePlanUpdateResponse.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Queues downgrade billing plan request for an account.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • opts (keyword): Optional parameters
    • :body (DowngradeBillingPlanInformation):

Returns

  • {:ok, DocuSign.Model.DowngradePlanUpdateResponse.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

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

Gets 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 (keyword): Optional parameters

Returns

  • {:ok, DocuSign.Model.BillingPlanResponse.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

billing_plans_get_billing_plans(connection, opts \\ [])

View Source 
@spec billing_plans_get_billing_plans(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, DocuSign.Model.BillingPlansResponse.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (DocuSign.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, DocuSign.Model.BillingPlansResponse.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

View Source 
@spec purchased_envelopes_put_purchased_envelopes(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, nil} | {:ok, DocuSign.Model.ErrorDetails.t()} | {:error, Tesla.Env.t()}

Reserved: 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 (keyword): Optional parameters
    • :body (PurchasedEnvelopesInformation):

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure