Python 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:

Python Example

import sys
import chilkat

rest = chilkat.CkRest()

#  URL: https://api.stripe.com/v1/invoices/in_1BnETLGswQrCoh0X6M67Qy9c/lines?limit=5
bTls = True
port = 443
bAutoReconnect = True
success = rest.Connect("api.stripe.com",port,bTls,bAutoReconnect)
if (success != True):
    print("ConnectFailReason: " + str(rest.get_ConnectFailReason()))
    print(rest.lastErrorText())
    sys.exit()

rest.SetAuthBasic("STRIPE_SECRET_KEY","")

sbResponseBody = chilkat.CkStringBuilder()
success = rest.FullRequestNoBodySb("GET","/v1/invoices/in_1BnETLGswQrCoh0X6M67Qy9c/lines?limit=5",sbResponseBody)
if (success != True):
    print(rest.lastErrorText())
    sys.exit()

jsonResponse = chilkat.CkJsonObject()
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")
    amount = jsonResponse.IntOf("data[i].amount")
    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")
    periodEnd = jsonResponse.IntOf("data[i].period.end")
    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"
    }
  ]
}