unicodeC / DocuSign REST API / Updates the account billing plan.
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkHttpResponseW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW json;
HCkStringBuilderW sbRequestBody;
HCkHttpResponseW resp;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "planInformation": {
// "planId": "sample string 1",
// "planFeatureSets": [
// {
// "featureSetId": "sample string 1",
// "isActive": "sample string 2",
// "name": "sample string 3",
// "fixedFee": "sample string 4",
// "envelopeFee": "sample string 5",
// "seatFee": "sample string 6",
// "isEnabled": "sample string 7",
// "is21CFRPart11": "sample string 8",
// "currencyFeatureSetPrices": [
// {
// "currencyCode": "sample string 1",
// "fixedFee": "sample string 2",
// "seatFee": "sample string 3",
// "envelopeFee": "sample string 4",
// "currencySymbol": "sample string 5"
// }
// ]
// }
// ],
// "addOns": [
// {
// "id": "sample string 1",
// "addOnId": "sample string 2",
// "name": "sample string 3",
// "active": "sample string 4"
// }
// ],
// "recipientDomains": [
// {
// "recipientDomainId": "sample string 1",
// "domainCode": "sample string 2",
// "domainName": "sample string 3",
// "active": "sample string 4"
// }
// ],
// "currencyCode": "sample string 2",
// "freeTrialDaysOverride": "sample string 3"
// },
// "enableSupport": "sample string 1",
// "includedSeats": "sample string 2",
// "incrementalSeats": "sample string 3",
// "saleDiscountPercent": "sample string 4",
// "saleDiscountAmount": "sample string 5",
// "saleDiscountFixedAmount": "sample string 6",
// "saleDiscountPeriods": "sample string 7",
// "saleDiscountSeatPriceOverride": "sample string 8",
// "renewalStatus": "sample string 9",
// "downgradeReason": "sample string 10",
// "creditCardInformation": {
// "cardNumber": "sample string 1",
// "expirationMonth": "sample string 2",
// "expirationYear": "sample string 3",
// "nameOnCard": "sample string 4",
// "cardType": "sample string 5",
// "address": {
// "street1": "sample string 1",
// "street2": "sample string 2",
// "city": "sample string 3",
// "state": "sample string 4",
// "zip": "sample string 5",
// "phone": "sample string 6",
// "fax": "sample string 7",
// "country": "sample string 8",
// "zipPlus4": "sample string 9"
// }
// },
// "appStoreReceipt": {
// "productId": "sample string 1",
// "receiptData": "sample string 2"
// },
// "billingAddress": {
// "address1": "sample string 1",
// "address2": "sample string 2",
// "city": "sample string 3",
// "state": "sample string 4",
// "postalCode": "sample string 5",
// "phone": "sample string 6",
// "fax": "sample string 7",
// "country": "sample string 8",
// "firstName": "sample string 9",
// "lastName": "sample string 10",
// "email": "sample string 11",
// "supportedCountries": [
// {
// "isoCode": "sample string 1",
// "provinceValidated": "sample string 2",
// "name": "sample string 3",
// "provinces": [
// {
// "isoCode": "sample string 1",
// "name": "sample string 2"
// }
// ]
// }
// ]
// },
// "referralInformation": {
// "enableSupport": "sample string 1",
// "includedSeats": "sample string 2",
// "saleDiscountPercent": "sample string 3",
// "saleDiscountAmount": "sample string 4",
// "saleDiscountFixedAmount": "sample string 5",
// "saleDiscountPeriods": "sample string 6",
// "saleDiscountSeatPriceOverride": "sample string 7",
// "planStartMonth": "sample string 8",
// "referralCode": "sample string 9",
// "referrerName": "sample string 10",
// "advertisementId": "sample string 11",
// "publisherId": "sample string 12",
// "shopperId": "sample string 13",
// "promoCode": "sample string 14",
// "groupMemberId": "sample string 15",
// "idType": "sample string 16",
// "industry": "sample string 17",
// "externalOrgId": "sample string 18"
// },
// "paymentProcessorInformation": {
// "billingAgreementId": "sample string 1",
// "email": "sample string 2",
// "address": {}
// }
// }
json = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(json,L"planInformation.planId",L"sample string 1");
CkJsonObjectW_UpdateString(json,L"planInformation.planFeatureSets[0].featureSetId",L"sample string 1");
CkJsonObjectW_UpdateString(json,L"planInformation.planFeatureSets[0].isActive",L"sample string 2");
CkJsonObjectW_UpdateString(json,L"planInformation.planFeatureSets[0].name",L"sample string 3");
CkJsonObjectW_UpdateString(json,L"planInformation.planFeatureSets[0].fixedFee",L"sample string 4");
CkJsonObjectW_UpdateString(json,L"planInformation.planFeatureSets[0].envelopeFee",L"sample string 5");
CkJsonObjectW_UpdateString(json,L"planInformation.planFeatureSets[0].seatFee",L"sample string 6");
CkJsonObjectW_UpdateString(json,L"planInformation.planFeatureSets[0].isEnabled",L"sample string 7");
CkJsonObjectW_UpdateString(json,L"planInformation.planFeatureSets[0].is21CFRPart11",L"sample string 8");
CkJsonObjectW_UpdateString(json,L"planInformation.planFeatureSets[0].currencyFeatureSetPrices[0].currencyCode",L"sample string 1");
CkJsonObjectW_UpdateString(json,L"planInformation.planFeatureSets[0].currencyFeatureSetPrices[0].fixedFee",L"sample string 2");
CkJsonObjectW_UpdateString(json,L"planInformation.planFeatureSets[0].currencyFeatureSetPrices[0].seatFee",L"sample string 3");
CkJsonObjectW_UpdateString(json,L"planInformation.planFeatureSets[0].currencyFeatureSetPrices[0].envelopeFee",L"sample string 4");
CkJsonObjectW_UpdateString(json,L"planInformation.planFeatureSets[0].currencyFeatureSetPrices[0].currencySymbol",L"sample string 5");
CkJsonObjectW_UpdateString(json,L"planInformation.addOns[0].id",L"sample string 1");
CkJsonObjectW_UpdateString(json,L"planInformation.addOns[0].addOnId",L"sample string 2");
CkJsonObjectW_UpdateString(json,L"planInformation.addOns[0].name",L"sample string 3");
CkJsonObjectW_UpdateString(json,L"planInformation.addOns[0].active",L"sample string 4");
CkJsonObjectW_UpdateString(json,L"planInformation.recipientDomains[0].recipientDomainId",L"sample string 1");
CkJsonObjectW_UpdateString(json,L"planInformation.recipientDomains[0].domainCode",L"sample string 2");
CkJsonObjectW_UpdateString(json,L"planInformation.recipientDomains[0].domainName",L"sample string 3");
CkJsonObjectW_UpdateString(json,L"planInformation.recipientDomains[0].active",L"sample string 4");
CkJsonObjectW_UpdateString(json,L"planInformation.currencyCode",L"sample string 2");
CkJsonObjectW_UpdateString(json,L"planInformation.freeTrialDaysOverride",L"sample string 3");
CkJsonObjectW_UpdateString(json,L"enableSupport",L"sample string 1");
CkJsonObjectW_UpdateString(json,L"includedSeats",L"sample string 2");
CkJsonObjectW_UpdateString(json,L"incrementalSeats",L"sample string 3");
CkJsonObjectW_UpdateString(json,L"saleDiscountPercent",L"sample string 4");
CkJsonObjectW_UpdateString(json,L"saleDiscountAmount",L"sample string 5");
CkJsonObjectW_UpdateString(json,L"saleDiscountFixedAmount",L"sample string 6");
CkJsonObjectW_UpdateString(json,L"saleDiscountPeriods",L"sample string 7");
CkJsonObjectW_UpdateString(json,L"saleDiscountSeatPriceOverride",L"sample string 8");
CkJsonObjectW_UpdateString(json,L"renewalStatus",L"sample string 9");
CkJsonObjectW_UpdateString(json,L"downgradeReason",L"sample string 10");
CkJsonObjectW_UpdateString(json,L"creditCardInformation.cardNumber",L"sample string 1");
CkJsonObjectW_UpdateString(json,L"creditCardInformation.expirationMonth",L"sample string 2");
CkJsonObjectW_UpdateString(json,L"creditCardInformation.expirationYear",L"sample string 3");
CkJsonObjectW_UpdateString(json,L"creditCardInformation.nameOnCard",L"sample string 4");
CkJsonObjectW_UpdateString(json,L"creditCardInformation.cardType",L"sample string 5");
CkJsonObjectW_UpdateString(json,L"creditCardInformation.address.street1",L"sample string 1");
CkJsonObjectW_UpdateString(json,L"creditCardInformation.address.street2",L"sample string 2");
CkJsonObjectW_UpdateString(json,L"creditCardInformation.address.city",L"sample string 3");
CkJsonObjectW_UpdateString(json,L"creditCardInformation.address.state",L"sample string 4");
CkJsonObjectW_UpdateString(json,L"creditCardInformation.address.zip",L"sample string 5");
CkJsonObjectW_UpdateString(json,L"creditCardInformation.address.phone",L"sample string 6");
CkJsonObjectW_UpdateString(json,L"creditCardInformation.address.fax",L"sample string 7");
CkJsonObjectW_UpdateString(json,L"creditCardInformation.address.country",L"sample string 8");
CkJsonObjectW_UpdateString(json,L"creditCardInformation.address.zipPlus4",L"sample string 9");
CkJsonObjectW_UpdateString(json,L"appStoreReceipt.productId",L"sample string 1");
CkJsonObjectW_UpdateString(json,L"appStoreReceipt.receiptData",L"sample string 2");
CkJsonObjectW_UpdateString(json,L"billingAddress.address1",L"sample string 1");
CkJsonObjectW_UpdateString(json,L"billingAddress.address2",L"sample string 2");
CkJsonObjectW_UpdateString(json,L"billingAddress.city",L"sample string 3");
CkJsonObjectW_UpdateString(json,L"billingAddress.state",L"sample string 4");
CkJsonObjectW_UpdateString(json,L"billingAddress.postalCode",L"sample string 5");
CkJsonObjectW_UpdateString(json,L"billingAddress.phone",L"sample string 6");
CkJsonObjectW_UpdateString(json,L"billingAddress.fax",L"sample string 7");
CkJsonObjectW_UpdateString(json,L"billingAddress.country",L"sample string 8");
CkJsonObjectW_UpdateString(json,L"billingAddress.firstName",L"sample string 9");
CkJsonObjectW_UpdateString(json,L"billingAddress.lastName",L"sample string 10");
CkJsonObjectW_UpdateString(json,L"billingAddress.email",L"sample string 11");
CkJsonObjectW_UpdateString(json,L"billingAddress.supportedCountries[0].isoCode",L"sample string 1");
CkJsonObjectW_UpdateString(json,L"billingAddress.supportedCountries[0].provinceValidated",L"sample string 2");
CkJsonObjectW_UpdateString(json,L"billingAddress.supportedCountries[0].name",L"sample string 3");
CkJsonObjectW_UpdateString(json,L"billingAddress.supportedCountries[0].provinces[0].isoCode",L"sample string 1");
CkJsonObjectW_UpdateString(json,L"billingAddress.supportedCountries[0].provinces[0].name",L"sample string 2");
CkJsonObjectW_UpdateString(json,L"referralInformation.enableSupport",L"sample string 1");
CkJsonObjectW_UpdateString(json,L"referralInformation.includedSeats",L"sample string 2");
CkJsonObjectW_UpdateString(json,L"referralInformation.saleDiscountPercent",L"sample string 3");
CkJsonObjectW_UpdateString(json,L"referralInformation.saleDiscountAmount",L"sample string 4");
CkJsonObjectW_UpdateString(json,L"referralInformation.saleDiscountFixedAmount",L"sample string 5");
CkJsonObjectW_UpdateString(json,L"referralInformation.saleDiscountPeriods",L"sample string 6");
CkJsonObjectW_UpdateString(json,L"referralInformation.saleDiscountSeatPriceOverride",L"sample string 7");
CkJsonObjectW_UpdateString(json,L"referralInformation.planStartMonth",L"sample string 8");
CkJsonObjectW_UpdateString(json,L"referralInformation.referralCode",L"sample string 9");
CkJsonObjectW_UpdateString(json,L"referralInformation.referrerName",L"sample string 10");
CkJsonObjectW_UpdateString(json,L"referralInformation.advertisementId",L"sample string 11");
CkJsonObjectW_UpdateString(json,L"referralInformation.publisherId",L"sample string 12");
CkJsonObjectW_UpdateString(json,L"referralInformation.shopperId",L"sample string 13");
CkJsonObjectW_UpdateString(json,L"referralInformation.promoCode",L"sample string 14");
CkJsonObjectW_UpdateString(json,L"referralInformation.groupMemberId",L"sample string 15");
CkJsonObjectW_UpdateString(json,L"referralInformation.idType",L"sample string 16");
CkJsonObjectW_UpdateString(json,L"referralInformation.industry",L"sample string 17");
CkJsonObjectW_UpdateString(json,L"referralInformation.externalOrgId",L"sample string 18");
CkJsonObjectW_UpdateString(json,L"paymentProcessorInformation.billingAgreementId",L"sample string 1");
CkJsonObjectW_UpdateString(json,L"paymentProcessorInformation.email",L"sample string 2");
CkJsonObjectW_UpdateNewObject(json,L"paymentProcessorInformation.address");
// Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttpW_putAuthToken(http,L"{{accessToken}}");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
sbRequestBody = CkStringBuilderW_Create();
CkJsonObjectW_EmitSb(json,sbRequestBody);
resp = CkHttpW_PTextSb(http,L"PUT",L"https://domain.com/v2.1/accounts/{{accountId}}/billing_plan?preview_billing_plan={{preview_billing_plan}}",sbRequestBody,L"utf-8",L"application/json",FALSE,FALSE);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
return;
}
wprintf(L"%d\n",CkHttpResponseW_getStatusCode(resp));
wprintf(L"%s\n",CkHttpResponseW_bodyStr(resp));
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
}
Curl Command
curl -X PUT
-H "Accept: application/json"
-H "Authorization: Bearer {{accessToken}}"
-d '{
"planInformation": {
"planId": "sample string 1",
"planFeatureSets": [
{
"featureSetId": "sample string 1",
"isActive": "sample string 2",
"name": "sample string 3",
"fixedFee": "sample string 4",
"envelopeFee": "sample string 5",
"seatFee": "sample string 6",
"isEnabled": "sample string 7",
"is21CFRPart11": "sample string 8",
"currencyFeatureSetPrices": [
{
"currencyCode": "sample string 1",
"fixedFee": "sample string 2",
"seatFee": "sample string 3",
"envelopeFee": "sample string 4",
"currencySymbol": "sample string 5"
}
]
}
],
"addOns": [
{
"id": "sample string 1",
"addOnId": "sample string 2",
"name": "sample string 3",
"active": "sample string 4"
}
],
"recipientDomains": [
{
"recipientDomainId": "sample string 1",
"domainCode": "sample string 2",
"domainName": "sample string 3",
"active": "sample string 4"
}
],
"currencyCode": "sample string 2",
"freeTrialDaysOverride": "sample string 3"
},
"enableSupport": "sample string 1",
"includedSeats": "sample string 2",
"incrementalSeats": "sample string 3",
"saleDiscountPercent": "sample string 4",
"saleDiscountAmount": "sample string 5",
"saleDiscountFixedAmount": "sample string 6",
"saleDiscountPeriods": "sample string 7",
"saleDiscountSeatPriceOverride": "sample string 8",
"renewalStatus": "sample string 9",
"downgradeReason": "sample string 10",
"creditCardInformation": {
"cardNumber": "sample string 1",
"expirationMonth": "sample string 2",
"expirationYear": "sample string 3",
"nameOnCard": "sample string 4",
"cardType": "sample string 5",
"address": {
"street1": "sample string 1",
"street2": "sample string 2",
"city": "sample string 3",
"state": "sample string 4",
"zip": "sample string 5",
"phone": "sample string 6",
"fax": "sample string 7",
"country": "sample string 8",
"zipPlus4": "sample string 9"
}
},
"appStoreReceipt": {
"productId": "sample string 1",
"receiptData": "sample string 2"
},
"billingAddress": {
"address1": "sample string 1",
"address2": "sample string 2",
"city": "sample string 3",
"state": "sample string 4",
"postalCode": "sample string 5",
"phone": "sample string 6",
"fax": "sample string 7",
"country": "sample string 8",
"firstName": "sample string 9",
"lastName": "sample string 10",
"email": "sample string 11",
"supportedCountries": [
{
"isoCode": "sample string 1",
"provinceValidated": "sample string 2",
"name": "sample string 3",
"provinces": [
{
"isoCode": "sample string 1",
"name": "sample string 2"
}
]
}
]
},
"referralInformation": {
"enableSupport": "sample string 1",
"includedSeats": "sample string 2",
"saleDiscountPercent": "sample string 3",
"saleDiscountAmount": "sample string 4",
"saleDiscountFixedAmount": "sample string 5",
"saleDiscountPeriods": "sample string 6",
"saleDiscountSeatPriceOverride": "sample string 7",
"planStartMonth": "sample string 8",
"referralCode": "sample string 9",
"referrerName": "sample string 10",
"advertisementId": "sample string 11",
"publisherId": "sample string 12",
"shopperId": "sample string 13",
"promoCode": "sample string 14",
"groupMemberId": "sample string 15",
"idType": "sample string 16",
"industry": "sample string 17",
"externalOrgId": "sample string 18"
},
"paymentProcessorInformation": {
"billingAgreementId": "sample string 1",
"email": "sample string 2",
"address": {}
}
}'
https://domain.com/v2.1/accounts/{{accountId}}/billing_plan?preview_billing_plan={{preview_billing_plan}}
Postman Collection Item JSON
{
"name": "Updates the account billing plan.",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"planInformation\": {\n \"planId\": \"sample string 1\",\n \"planFeatureSets\": [\n {\n \"featureSetId\": \"sample string 1\",\n \"isActive\": \"sample string 2\",\n \"name\": \"sample string 3\",\n \"fixedFee\": \"sample string 4\",\n \"envelopeFee\": \"sample string 5\",\n \"seatFee\": \"sample string 6\",\n \"isEnabled\": \"sample string 7\",\n \"is21CFRPart11\": \"sample string 8\",\n \"currencyFeatureSetPrices\": [\n {\n \"currencyCode\": \"sample string 1\",\n \"fixedFee\": \"sample string 2\",\n \"seatFee\": \"sample string 3\",\n \"envelopeFee\": \"sample string 4\",\n \"currencySymbol\": \"sample string 5\"\n }\n ]\n }\n ],\n \"addOns\": [\n {\n \"id\": \"sample string 1\",\n \"addOnId\": \"sample string 2\",\n \"name\": \"sample string 3\",\n \"active\": \"sample string 4\"\n }\n ],\n \"recipientDomains\": [\n {\n \"recipientDomainId\": \"sample string 1\",\n \"domainCode\": \"sample string 2\",\n \"domainName\": \"sample string 3\",\n \"active\": \"sample string 4\"\n }\n ],\n \"currencyCode\": \"sample string 2\",\n \"freeTrialDaysOverride\": \"sample string 3\"\n },\n \"enableSupport\": \"sample string 1\",\n \"includedSeats\": \"sample string 2\",\n \"incrementalSeats\": \"sample string 3\",\n \"saleDiscountPercent\": \"sample string 4\",\n \"saleDiscountAmount\": \"sample string 5\",\n \"saleDiscountFixedAmount\": \"sample string 6\",\n \"saleDiscountPeriods\": \"sample string 7\",\n \"saleDiscountSeatPriceOverride\": \"sample string 8\",\n \"renewalStatus\": \"sample string 9\",\n \"downgradeReason\": \"sample string 10\",\n \"creditCardInformation\": {\n \"cardNumber\": \"sample string 1\",\n \"expirationMonth\": \"sample string 2\",\n \"expirationYear\": \"sample string 3\",\n \"nameOnCard\": \"sample string 4\",\n \"cardType\": \"sample string 5\",\n \"address\": {\n \"street1\": \"sample string 1\",\n \"street2\": \"sample string 2\",\n \"city\": \"sample string 3\",\n \"state\": \"sample string 4\",\n \"zip\": \"sample string 5\",\n \"phone\": \"sample string 6\",\n \"fax\": \"sample string 7\",\n \"country\": \"sample string 8\",\n \"zipPlus4\": \"sample string 9\"\n }\n },\n \"appStoreReceipt\": {\n \"productId\": \"sample string 1\",\n \"receiptData\": \"sample string 2\"\n },\n \"billingAddress\": {\n \"address1\": \"sample string 1\",\n \"address2\": \"sample string 2\",\n \"city\": \"sample string 3\",\n \"state\": \"sample string 4\",\n \"postalCode\": \"sample string 5\",\n \"phone\": \"sample string 6\",\n \"fax\": \"sample string 7\",\n \"country\": \"sample string 8\",\n \"firstName\": \"sample string 9\",\n \"lastName\": \"sample string 10\",\n \"email\": \"sample string 11\",\n \"supportedCountries\": [\n {\n \"isoCode\": \"sample string 1\",\n \"provinceValidated\": \"sample string 2\",\n \"name\": \"sample string 3\",\n \"provinces\": [\n {\n \"isoCode\": \"sample string 1\",\n \"name\": \"sample string 2\"\n }\n ]\n }\n ]\n },\n \"referralInformation\": {\n \"enableSupport\": \"sample string 1\",\n \"includedSeats\": \"sample string 2\",\n \"saleDiscountPercent\": \"sample string 3\",\n \"saleDiscountAmount\": \"sample string 4\",\n \"saleDiscountFixedAmount\": \"sample string 5\",\n \"saleDiscountPeriods\": \"sample string 6\",\n \"saleDiscountSeatPriceOverride\": \"sample string 7\",\n \"planStartMonth\": \"sample string 8\",\n \"referralCode\": \"sample string 9\",\n \"referrerName\": \"sample string 10\",\n \"advertisementId\": \"sample string 11\",\n \"publisherId\": \"sample string 12\",\n \"shopperId\": \"sample string 13\",\n \"promoCode\": \"sample string 14\",\n \"groupMemberId\": \"sample string 15\",\n \"idType\": \"sample string 16\",\n \"industry\": \"sample string 17\",\n \"externalOrgId\": \"sample string 18\"\n },\n \"paymentProcessorInformation\": {\n \"billingAgreementId\": \"sample string 1\",\n \"email\": \"sample string 2\",\n \"address\": {}\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/billing_plan?preview_billing_plan={{preview_billing_plan}}",
"host": [
"{{baseUrl}}"
],
"path": [
"v2.1",
"accounts",
"{{accountId}}",
"billing_plan"
],
"query": [
{
"key": "preview_billing_plan",
"value": "{{preview_billing_plan}}"
}
],
"variable": [
{
"key": "accountId",
"value": "{{accountId}}"
}
]
},
"description": "Updates the billing plan information, billing address, and credit card information for the specified account."
},
"response": [
]
}
