Node.js Stripe: List all Coupons

Back to Index

Returns a list of your coupons.

Documentation: https://stripe.com/docs/api/curl#list_coupons

CURL Command

curl https://api.stripe.com/v1/coupons?limit=3 \
   -u STRIPE_SECRET_KEY: \
   -G

Node.js Example

var os = require('os');
if (os.platform() == 'win32') {  
    var chilkat = require('chilkat_node6_win32'); 
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('chilkat_node6_arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('chilkat_node6_linux32');
    } else {
        var chilkat = require('chilkat_node6_linux64');
    }
} else if (os.platform() == 'darwin') {
    var chilkat = require('chilkat_node6_macosx');
}

function chilkatExample() {

    var rest = new chilkat.Rest();
    var success;

    //  URL: https://api.stripe.com/v1/coupons?limit=3
    var bTls = true;
    var port = 443;
    var bAutoReconnect = true;
    success = rest.Connect("api.stripe.com",port,bTls,bAutoReconnect);
    if (success !== true) {
        console.log("ConnectFailReason: " + rest.ConnectFailReason);
        console.log(rest.LastErrorText);
        return;
    }

    rest.SetAuthBasic("STRIPE_SECRET_KEY","");

    var sbResponseBody = new chilkat.StringBuilder();
    success = rest.FullRequestNoBodySb("GET","/v1/coupons?limit=3",sbResponseBody);
    if (success !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    var jsonResponse = new chilkat.JsonObject();
    jsonResponse.LoadSb(sbResponseBody);

    var object;
    var url;
    var has_more;
    var i;
    var count_i;
    var id;
    var amount_off;
    var created;
    var currency;
    var duration;
    var duration_in_months;
    var livemode;
    var max_redemptions;
    var percent_off;
    var redeem_by;
    var times_redeemed;
    var valid;

    object = jsonResponse.StringOf("object");
    url = jsonResponse.StringOf("url");
    has_more = jsonResponse.BoolOf("has_more");
    i = 0;
    count_i = jsonResponse.SizeOfArray("data");
    while (i < count_i) {
        jsonResponse.I = i;
        id = jsonResponse.StringOf("data[i].id");
        object = jsonResponse.StringOf("data[i].object");
        amount_off = jsonResponse.IsNullOf("data[i].amount_off");
        created = jsonResponse.IntOf("data[i].created");
        currency = jsonResponse.IsNullOf("data[i].currency");
        duration = jsonResponse.StringOf("data[i].duration");
        duration_in_months = jsonResponse.IntOf("data[i].duration_in_months");
        livemode = jsonResponse.BoolOf("data[i].livemode");
        max_redemptions = jsonResponse.IsNullOf("data[i].max_redemptions");
        percent_off = jsonResponse.IntOf("data[i].percent_off");
        redeem_by = jsonResponse.IsNullOf("data[i].redeem_by");
        times_redeemed = jsonResponse.IntOf("data[i].times_redeemed");
        valid = jsonResponse.BoolOf("data[i].valid");
        i = i+1;
    }


}

chilkatExample();

Sample JSON Response Body

{
  "object": "list",
  "url": "/v1/coupons",
  "has_more": false,
  "data": [
    {
      "id": "25OFF",
      "object": "coupon",
      "amount_off": null,
      "created": 1516662783,
      "currency": null,
      "duration": "repeating",
      "duration_in_months": 3,
      "livemode": false,
      "max_redemptions": null,
      "metadata": {},
      "percent_off": 25,
      "redeem_by": null,
      "times_redeemed": 0,
      "valid": true
    }
  ]
}