Swift Stripe: Retrieve an Invoice's Line Items

Back to Index

Retrieves the line items for a given invoice.

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

CURL Command

curl https://api.stripe.com/v1/invoices/in_1BnETLGswQrCoh0X6M67Qy9c/lines?limit=5 \
   -u STRIPE_SECRET_KEY:

Swift Example

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

    //  URL: https://api.stripe.com/v1/invoices/in_1BnETLGswQrCoh0X6M67Qy9c/lines?limit=5
    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/invoices/in_1BnETLGswQrCoh0X6M67Qy9c/lines?limit=5", 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 amount: Int
    var currency: String?
    var description: String?
    var discountable: Bool
    var livemode: Bool
    var periodStart: Int
    var periodEnd: Int
    var plan: Bool
    var proration: Bool
    var quantity: Bool
    var subscription: Bool
    var type: String?

    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")
        amount = jsonResponse.IntOf("data[i].amount").integerValue
        currency = jsonResponse.StringOf("data[i].currency")
        description = jsonResponse.StringOf("data[i].description")
        discountable = jsonResponse.BoolOf("data[i].discountable")
        livemode = jsonResponse.BoolOf("data[i].livemode")
        periodStart = jsonResponse.IntOf("data[i].period.start").integerValue
        periodEnd = jsonResponse.IntOf("data[i].period.end").integerValue
        plan = jsonResponse.IsNullOf("data[i].plan")
        proration = jsonResponse.BoolOf("data[i].proration")
        quantity = jsonResponse.IsNullOf("data[i].quantity")
        subscription = jsonResponse.IsNullOf("data[i].subscription")
        type = jsonResponse.StringOf("data[i].type")
        i = i + 1
    }


}

Sample JSON Response Body

{
  "object": "list",
  "url": "/v1/invoices/in_1BnETLGswQrCoh0X6M67Qy9c/lines",
  "has_more": false,
  "data": [
    {
      "id": "ii_1BnETLGswQrCoh0XhmXYb8CY",
      "object": "line_item",
      "amount": 1000,
      "currency": "usd",
      "description": "My First Invoice Item (created for API docs)",
      "discountable": true,
      "livemode": false,
      "metadata": {},
      "period": {
        "start": 1516662783,
        "end": 1516662783
      },
      "plan": null,
      "proration": false,
      "quantity": null,
      "subscription": null,
      "type": "invoiceitem"
    }
  ]
}