Node.js Stripe: List all Customers

Back to Index

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

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

CURL Command

curl https://api.stripe.com/v1/customers?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/customers?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/customers?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 account_balance;
    var created;
    var currency;
    var default_source;
    var delinquent;
    var description;
    var discount;
    var email;
    var livemode;
    var shipping;
    var sourcesObject;
    var sourcesHas_more;
    var sourcesTotal_count;
    var sourcesUrl;
    var subscriptionsObject;
    var subscriptionsHas_more;
    var subscriptionsTotal_count;
    var subscriptionsUrl;
    var j;
    var count_j;

    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");
        account_balance = jsonResponse.IntOf("data[i].account_balance");
        created = jsonResponse.IntOf("data[i].created");
        currency = jsonResponse.StringOf("data[i].currency");
        default_source = jsonResponse.IsNullOf("data[i].default_source");
        delinquent = jsonResponse.BoolOf("data[i].delinquent");
        description = jsonResponse.IsNullOf("data[i].description");
        discount = jsonResponse.IsNullOf("data[i].discount");
        email = jsonResponse.IsNullOf("data[i].email");
        livemode = jsonResponse.BoolOf("data[i].livemode");
        shipping = jsonResponse.IsNullOf("data[i].shipping");
        sourcesObject = jsonResponse.StringOf("data[i].sources.object");
        sourcesHas_more = jsonResponse.BoolOf("data[i].sources.has_more");
        sourcesTotal_count = jsonResponse.IntOf("data[i].sources.total_count");
        sourcesUrl = jsonResponse.StringOf("data[i].sources.url");
        subscriptionsObject = jsonResponse.StringOf("data[i].subscriptions.object");
        subscriptionsHas_more = jsonResponse.BoolOf("data[i].subscriptions.has_more");
        subscriptionsTotal_count = jsonResponse.IntOf("data[i].subscriptions.total_count");
        subscriptionsUrl = jsonResponse.StringOf("data[i].subscriptions.url");
        j = 0;
        count_j = jsonResponse.SizeOfArray("data[i].sources.data");
        while (j < count_j) {
            jsonResponse.J = j;
            j = j+1;
        }

        j = 0;
        count_j = jsonResponse.SizeOfArray("data[i].subscriptions.data");
        while (j < count_j) {
            jsonResponse.J = j;
            j = j+1;
        }

        i = i+1;
    }


}

chilkatExample();

Sample JSON Response Body

{
  "object": "list",
  "url": "/v1/customers",
  "has_more": false,
  "data": [
    {
      "id": "cus_CBbgVLJqv487Oq",
      "object": "customer",
      "account_balance": 0,
      "created": 1516662781,
      "currency": "usd",
      "default_source": null,
      "delinquent": false,
      "description": null,
      "discount": null,
      "email": null,
      "livemode": false,
      "metadata": {},
      "shipping": null,
      "sources": {
        "object": "list",
        "data": [
        ],
        "has_more": false,
        "total_count": 0,
        "url": "/v1/customers/cus_CBbgVLJqv487Oq/sources"
      },
      "subscriptions": {
        "object": "list",
        "data": [
        ],
        "has_more": false,
        "total_count": 0,
        "url": "/v1/customers/cus_CBbgVLJqv487Oq/subscriptions"
      }
    }
  ]
}