Swift Stripe: Create an Invoice

Back to Index

Creates a customer invoice object.

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

CURL Command

curl https://api.stripe.com/v1/invoices \
   -u STRIPE_SECRET_KEY: \
   -d customer=cus_CBbg9PmQ9sLbmo \
   -X POST

Swift Example


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

    //  URL: https://api.stripe.com/v1/invoices
    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: "")

    rest.AddQueryParam("customer", value: "cus_CBbg9PmQ9sLbmo")

    var strResponseBody: String? = rest.FullRequestFormUrlEncoded("POST", uriPath: "/v1/invoices")
    if rest.LastMethodSuccess != true {
        print("\(rest.LastErrorText)")
        return
    }

    let jsonResponse = CkoJsonObject()
    jsonResponse.Load(strResponseBody)

    var id: String?
    var object: String?
    var amount_due: Int
    var application_fee: Bool
    var attempt_count: Int
    var attempted: Bool
    var billing: String?
    var charge: Bool
    var closed: Bool
    var currency: String?
    var customer: String?
    var date: Int
    var description: Bool
    var discount: Bool
    var due_date: Bool
    var ending_balance: Bool
    var forgiven: Bool
    var linesHas_more: Bool
    var linesObject: String?
    var linesUrl: String?
    var livemode: Bool
    var next_payment_attempt: Int
    var number: String?
    var paid: Bool
    var period_end: Int
    var period_start: Int
    var receipt_number: Bool
    var starting_balance: Int
    var statement_descriptor: Bool
    var subscription: Bool
    var subtotal: Int
    var tax: Bool
    var tax_percent: Bool
    var total: Int
    var webhooks_delivered_at: Bool
    var i: Int
    var count_i: Int
    var amount: Int
    var description_str: String?
    var discountable: Bool
    var periodStart: Int
    var periodEnd: Int
    var plan: Bool
    var proration: Bool
    var quantity: Bool
    var type: String?

    id = jsonResponse.StringOf("id")
    object = jsonResponse.StringOf("object")
    amount_due = jsonResponse.IntOf("amount_due").integerValue
    application_fee = jsonResponse.IsNullOf("application_fee")
    attempt_count = jsonResponse.IntOf("attempt_count").integerValue
    attempted = jsonResponse.BoolOf("attempted")
    billing = jsonResponse.StringOf("billing")
    charge = jsonResponse.IsNullOf("charge")
    closed = jsonResponse.BoolOf("closed")
    currency = jsonResponse.StringOf("currency")
    customer = jsonResponse.StringOf("customer")
    date = jsonResponse.IntOf("date").integerValue
    description = jsonResponse.IsNullOf("description")
    discount = jsonResponse.IsNullOf("discount")
    due_date = jsonResponse.IsNullOf("due_date")
    ending_balance = jsonResponse.IsNullOf("ending_balance")
    forgiven = jsonResponse.BoolOf("forgiven")
    linesHas_more = jsonResponse.BoolOf("lines.has_more")
    linesObject = jsonResponse.StringOf("lines.object")
    linesUrl = jsonResponse.StringOf("lines.url")
    livemode = jsonResponse.BoolOf("livemode")
    next_payment_attempt = jsonResponse.IntOf("next_payment_attempt").integerValue
    number = jsonResponse.StringOf("number")
    paid = jsonResponse.BoolOf("paid")
    period_end = jsonResponse.IntOf("period_end").integerValue
    period_start = jsonResponse.IntOf("period_start").integerValue
    receipt_number = jsonResponse.IsNullOf("receipt_number")
    starting_balance = jsonResponse.IntOf("starting_balance").integerValue
    statement_descriptor = jsonResponse.IsNullOf("statement_descriptor")
    subscription = jsonResponse.IsNullOf("subscription")
    subtotal = jsonResponse.IntOf("subtotal").integerValue
    tax = jsonResponse.IsNullOf("tax")
    tax_percent = jsonResponse.IsNullOf("tax_percent")
    total = jsonResponse.IntOf("total").integerValue
    webhooks_delivered_at = jsonResponse.IsNullOf("webhooks_delivered_at")
    i = 0
    count_i = jsonResponse.SizeOfArray("lines.data").integerValue
    while i < count_i {
        jsonResponse.I = i
        id = jsonResponse.StringOf("lines.data[i].id")
        object = jsonResponse.StringOf("lines.data[i].object")
        amount = jsonResponse.IntOf("lines.data[i].amount").integerValue
        currency = jsonResponse.StringOf("lines.data[i].currency")
        description_str = jsonResponse.StringOf("lines.data[i].description")
        discountable = jsonResponse.BoolOf("lines.data[i].discountable")
        livemode = jsonResponse.BoolOf("lines.data[i].livemode")
        periodStart = jsonResponse.IntOf("lines.data[i].period.start").integerValue
        periodEnd = jsonResponse.IntOf("lines.data[i].period.end").integerValue
        plan = jsonResponse.IsNullOf("lines.data[i].plan")
        proration = jsonResponse.BoolOf("lines.data[i].proration")
        quantity = jsonResponse.IsNullOf("lines.data[i].quantity")
        subscription = jsonResponse.IsNullOf("lines.data[i].subscription")
        type = jsonResponse.StringOf("lines.data[i].type")
        i = i + 1
    }


}

Sample JSON Response Body

{
  "id": "in_1BnETLGswQrCoh0XR7p1RCtV",
  "object": "invoice",
  "amount_due": 0,
  "application_fee": null,
  "attempt_count": 0,
  "attempted": false,
  "billing": "charge_automatically",
  "charge": null,
  "closed": false,
  "currency": "usd",
  "customer": "cus_CBbg9PmQ9sLbmo",
  "date": 1516662783,
  "description": null,
  "discount": null,
  "due_date": null,
  "ending_balance": null,
  "forgiven": false,
  "lines": {
    "data": [
      {
        "id": "ii_1BnETLGswQrCoh0XsAcSzoLf",
        "object": "line_item",
        "amount": 0,
        "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"
      }
    ],
    "has_more": false,
    "object": "list",
    "url": "/v1/invoices/in_1BnETLGswQrCoh0XR7p1RCtV/lines"
  },
  "livemode": false,
  "metadata": {},
  "next_payment_attempt": 1516666383,
  "number": "36eba31eaa-0001",
  "paid": false,
  "period_end": 1516662783,
  "period_start": 1516662783,
  "receipt_number": null,
  "starting_balance": 0,
  "statement_descriptor": null,
  "subscription": null,
  "subtotal": 0,
  "tax": null,
  "tax_percent": null,
  "total": 0,
  "webhooks_delivered_at": null
}