Swift 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

Swift Example

func chilkatTest() {
    let rest = CkoRest()
    var success: Bool

    //  URL: https://api.stripe.com/v1/customers?limit=3
    var bTls: Bool = true
    var port: Int = 443
    var bAutoReconnect: Bool = true
    success = rest.Connect("api.stripe.com", port: port, tls: bTls, autoReconnect: bAutoReconnect)
    if success != true {
        print("ConnectFailReason: \(rest.ConnectFailReason.integerValue)")
        print("\(rest.LastErrorText)")
        return
    }

    rest.SetAuthBasic("STRIPE_SECRET_KEY", password: "")

    let sbResponseBody = CkoStringBuilder()
    success = rest.FullRequestNoBodySb("GET", uriPath: "/v1/customers?limit=3", sb: sbResponseBody)
    if success != true {
        print("\(rest.LastErrorText)")
        return
    }

    let jsonResponse = CkoJsonObject()
    jsonResponse.LoadSb(sbResponseBody)

    var object: String?
    var url: String?
    var has_more: Bool
    var i: Int
    var count_i: Int
    var id: String?
    var account_balance: Int
    var created: Int
    var currency: String?
    var default_source: Bool
    var delinquent: Bool
    var description: Bool
    var discount: Bool
    var email: Bool
    var livemode: Bool
    var shipping: Bool
    var sourcesObject: String?
    var sourcesHas_more: Bool
    var sourcesTotal_count: Int
    var sourcesUrl: String?
    var subscriptionsObject: String?
    var subscriptionsHas_more: Bool
    var subscriptionsTotal_count: Int
    var subscriptionsUrl: String?
    var j: Int
    var count_j: Int

    object = jsonResponse.StringOf("object")
    url = jsonResponse.StringOf("url")
    has_more = jsonResponse.BoolOf("has_more")
    i = 0
    count_i = jsonResponse.SizeOfArray("data").integerValue
    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").integerValue
        created = jsonResponse.IntOf("data[i].created").integerValue
        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").integerValue
        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").integerValue
        subscriptionsUrl = jsonResponse.StringOf("data[i].subscriptions.url")
        j = 0
        count_j = jsonResponse.SizeOfArray("data[i].sources.data").integerValue
        while j < count_j {
            jsonResponse.J = j
            j = j + 1
        }

        j = 0
        count_j = jsonResponse.SizeOfArray("data[i].subscriptions.data").integerValue
        while j < count_j {
            jsonResponse.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"
      }
    }
  ]
}