Sample code for 30+ languages & platforms
JavaScript Requires Chilkat v11.0.0+

PayPal: Suspend an active subscription

See more PayPal Examples

Pause future billing after checking that the subscription is active. Save the reason with the customer support record.

PayPal documentation

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.
JavaScript
var success = false;

//  See Unlock Chilkat before making requests.
//  For the merchant's internal backoffice application. Load the sandbox token
//  from the merchant's credential store. Keep it out of publicly distributed apps.
//  See Get a PayPal access token.
var http = new CkHttp();
http.AuthToken = "SANDBOX_ACCESS_TOKEN";
var resp = new CkHttpResponse();

http.SetUrlVar("id","SUBSCRIPTION_ID");

success = http.HttpNoBody("GET","https://api-m.sandbox.paypal.com/v1/billing/subscriptions/{$id}",resp);
if (success !== true) {
    console.log("No HTTP response: " + http.LastErrorText);
    return;
}

if ((resp.StatusCode < 200) || (resp.StatusCode >= 300)) {
    var errorInfo = new CkJsonObject();
    errorInfo.Load(resp.BodyStr);
    console.log("HTTP " + resp.StatusCode + " " + errorInfo.StringOf("name") + " " + errorInfo.StringOf("details[0].issue"));
    console.log("PayPal debug ID: " + errorInfo.StringOf("debug_id"));
    return;
}

var result = new CkJsonObject();
var parsedResult = result.Load(resp.BodyStr);
if (parsedResult !== true) {
    console.log("Expected a JSON response; HTTP " + resp.StatusCode);
    return;
}

if (result.StringOfEquals("status","ACTIVE",true) !== true) {
    console.log("Subscription status is " + result.StringOf("status") + ". No change made.");
    return;
}

var body = new CkJsonObject();
body.UpdateString("reason","Customer requested a billing pause.");
success = http.HttpJson("POST","https://api-m.sandbox.paypal.com/v1/billing/subscriptions/{$id}/suspend",body,"application/json",resp);
if (success !== true) {
    console.log("No HTTP response: " + http.LastErrorText);
    return;
}

if ((resp.StatusCode < 200) || (resp.StatusCode >= 300)) {
    var changeError = new CkJsonObject();
    changeError.Load(resp.BodyStr);
    console.log("HTTP " + resp.StatusCode + " " + changeError.StringOf("name") + " " + changeError.StringOf("details[0].issue"));
    console.log("PayPal debug ID: " + changeError.StringOf("debug_id"));
    return;
}

console.log("PayPal accepted the subscription change.");