Chilkat Online Tools

lianja / DocuSign eSignature REST API / Get Account Billing Plan

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loHttp = createobject("CkHttp")

loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("include_credit_card_information","{{include_credit_card_information}}")
loQueryParams.UpdateString("include_metadata","{{include_metadata}}")
loQueryParams.UpdateString("include_successor_plans","{{include_successor_plans}}")

// Adds the "Authorization: Bearer {{accessToken}}" header.
loHttp.AuthToken = "{{accessToken}}"
loHttp.SetRequestHeader("Accept","application/json")

loResp = loHttp.QuickRequestParams("GET","https://domain.com/v2.1/accounts/{{accountId}}/billing_plan",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loQueryParams
    return
endif

? str(loResp.StatusCode)
? loResp.BodyStr
release loResp


release loHttp
release loQueryParams

Curl Command

curl -G -d "include_credit_card_information=%7B%7Binclude_credit_card_information%7D%7D"
	-d "include_metadata=%7B%7Binclude_metadata%7D%7D"
	-d "include_successor_plans=%7B%7Binclude_successor_plans%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/billing_plan

Postman Collection Item JSON

{
  "name": "Get Account Billing Plan",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/billing_plan?include_credit_card_information={{include_credit_card_information}}&include_metadata={{include_metadata}}&include_successor_plans={{include_successor_plans}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "billing_plan"
      ],
      "query": [
        {
          "key": "include_credit_card_information",
          "value": "{{include_credit_card_information}}"
        },
        {
          "key": "include_metadata",
          "value": "{{include_metadata}}"
        },
        {
          "key": "include_successor_plans",
          "value": "{{include_successor_plans}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        }
      ]
    },
    "description": "Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card.\n\nBy 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**. \n\nResponse\n\nThe 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.\n\n###### 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. "
  },
  "response": [
  ]
}