JavaScript Requires Chilkat v11.7.0+
JavaScript
Stripe: Preview a plan or seat change
See more Stripe Examples
Preview a seat or plan change and display its proration lines, total, and the timestamp to retain with the quote.
Stripe documentation and cURL example
Note
This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat
v11.4.0 or greater.
var success = false;
// Requires an unlocked Chilkat bundle. See Global Unlock Sample.
// Supply a restricted sandbox key from merchant-controlled configuration.
var apiKey = "YOUR_STRIPE_TEST_KEY";
var curl = new CkHttpCurl();
var cmd = new CkStringBuilder();
var json = new CkJsonObject();
var replaced;
var subscriptionId = "sub_FROM_ACCOUNT";
var itemId = "si_SELECTED_ITEM";
var priceId = "price_FROM_CATALOG";
var now = new CkDateTime();
now.SetFromCurrentSystemTime();
var prorationDate = now.GetAsUnixTimeStr(false);
// curl -X POST "https://api.stripe.com/v1/invoices/create_preview" \
// -u "$STRIPE_API_KEY:" \
// -H "Stripe-Version: 2026-10-28.endive" \
// -d "subscription={subscriptionId}" \
// -d "subscription_details[items][0][id]={itemId}" \
// -d "subscription_details[items][0][price]={priceId}" \
// -d "subscription_details[items][0][quantity]=5" \
// -d "subscription_details[proration_behavior]=create_prorations" \
// -d "subscription_details[proration_date]={prorationDate}"
cmd.SetString("curl -X POST \"https://api.stripe.com/v1/invoices/create_preview\"");
cmd.Append(" -u \"@KEY@:\"");
cmd.Append(" -H \"Stripe-Version: 2026-10-28.endive\"");
cmd.Append(" -d \"subscription=@SUB@\"");
cmd.Append(" -d \"subscription_details[items][0][id]=@ITEM@\"");
cmd.Append(" -d \"subscription_details[items][0][price]=@PRICE@\"");
cmd.Append(" -d \"subscription_details[items][0][quantity]=5\"");
cmd.Append(" -d \"subscription_details[proration_behavior]=create_prorations\"");
cmd.Append(" -d \"subscription_details[proration_date]=@DATE@\"");
replaced = cmd.Replace("@SUB@",subscriptionId);
replaced = cmd.Replace("@ITEM@",itemId);
replaced = cmd.Replace("@PRICE@",priceId);
replaced = cmd.Replace("@DATE@",prorationDate);
replaced = cmd.Replace("@KEY@",apiKey);
success = curl.DoYourThing(cmd.GetAsString());
if (success !== true) {
console.log("No HTTP response. Chilkat failure code: " + curl.FailReason);
return;
}
success = curl.GetResponseJson(json);
if ((curl.StatusCode !== 200) || (success !== true)) {
console.log("Stripe HTTP " + curl.StatusCode + " Request-Id: " + curl.GetResponseHeaderField("Request-Id"));
if (success == true) {
console.log(json.StringOf("error.message"));
}
return;
}
console.log("total = " + json.StringOf("total"));
console.log("currency = " + json.StringOf("currency"));
console.log("Save this preview time with the selected changes: " + prorationDate);
var i = 0;
while ((i < json.SizeOfArray("lines.data"))) {
json.I = i;
if (json.BoolOf("lines.data[i].parent.subscription_item_details.proration") == true) {
console.log(json.StringOf("lines.data[i].description") + " " + json.StringOf("lines.data[i].amount"));
}
i = i+1;
}
if (json.BoolOf("lines.has_more") == true) {
console.log("Only the first page of preview lines is shown. The total covers all lines.");
}