Perl 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

Perl Example

use chilkat();

$rest = chilkat::CkRest->new();

#  URL: https://api.stripe.com/v1/customers?limit=3
$bTls = 1;
$port = 443;
$bAutoReconnect = 1;
$success = $rest->Connect("api.stripe.com",$port,$bTls,$bAutoReconnect);
if ($success != 1) {
    print "ConnectFailReason: " . $rest->get_ConnectFailReason() . "\r\n";
    print $rest->lastErrorText() . "\r\n";
    exit;
}

$rest->SetAuthBasic("STRIPE_SECRET_KEY","");

$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $rest->FullRequestNoBodySb("GET","/v1/customers?limit=3",$sbResponseBody);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

$jsonResponse = chilkat::CkJsonObject->new();
$jsonResponse->LoadSb($sbResponseBody);

$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->put_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->put_J($j);
        $j = $j + 1;
    }

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

    $i = $i + 1;
}

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"
      }
    }
  ]
}