Sample code for 30+ languages & platforms
PureBasic Requires Chilkat v11.7.0+

Stripe: Finalize and email a reviewed invoice

See more Stripe Examples

Finalize a reviewed draft and send the open invoice by email. Stripe test mode returns the API result without delivering an email.

Stripe documentation and cURL example

Chilkat PureBasic Downloads

PureBasic
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttpCurl.pb"

Procedure ChilkatExample()

    success.i = 0

    ;  Requires an unlocked Chilkat bundle. See Global Unlock Sample.
    ;  Supply a restricted sandbox key from merchant-controlled configuration.
    apiKey.s = "YOUR_STRIPE_TEST_KEY"
    ;  Load the saved UUID for this operation. Reuse it only for a retry with identical inputs.
    operationId.s = "YOUR_SAVED_OPERATION_UUID"

    curl.i = CkHttpCurl::ckCreate()
    If curl.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    cmd.i = CkStringBuilder::ckCreate()
    If cmd.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    replaced.i

    invoiceId.s = "in_FROM_BILLING_RECORD"

    ;  curl -X GET "https://api.stripe.com/v1/invoices/{invoiceId}" \
    ;    -u "$STRIPE_API_KEY:" \
    ;    -H "Stripe-Version: 2026-10-28.endive"
    CkStringBuilder::ckSetString(cmd,"curl -X GET " + Chr(34) + "https://api.stripe.com/v1/invoices/@ID@" + Chr(34))
    CkStringBuilder::ckAppend(cmd," -u " + Chr(34) + "@KEY@:" + Chr(34))
    CkStringBuilder::ckAppend(cmd," -H " + Chr(34) + "Stripe-Version: 2026-10-28.endive" + Chr(34))
    replaced = CkStringBuilder::ckReplace(cmd,"@ID@",invoiceId)
    replaced = CkStringBuilder::ckReplace(cmd,"@KEY@",apiKey)
    success = CkHttpCurl::ckDoYourThing(curl,CkStringBuilder::ckGetAsString(cmd))
    If success <> 1
        Debug "No HTTP response. Chilkat failure code: " + Str(CkHttpCurl::ckFailReason(curl))
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(cmd)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    success = CkHttpCurl::ckGetResponseJson(curl,json)
    If (CkHttpCurl::ckStatusCode(curl) <> 200) OR (success <> 1)
        Debug "Stripe HTTP " + Str(CkHttpCurl::ckStatusCode(curl)) + "  Request-Id: " + CkHttpCurl::ckGetResponseHeaderField(curl,"Request-Id")
        If success = 1
            Debug CkJsonObject::ckStringOf(json,"error.message")
        EndIf

        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(cmd)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    If CkJsonObject::ckStringOf(json,"collection_method") <> "send_invoice"
        Debug "Select an invoice intended for email collection."
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(cmd)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    If CkJsonObject::ckStringOf(json,"status") = "draft"
        ;  curl -X POST "https://api.stripe.com/v1/invoices/{invoiceId}/finalize" \
        ;    -u "$STRIPE_API_KEY:" \
        ;    -H "Stripe-Version: 2026-10-28.endive" \
        ;    -H "Idempotency-Key: {operationId}-finalize" \
        ;    -d "auto_advance=false"
        CkStringBuilder::ckSetString(cmd,"curl -X POST " + Chr(34) + "https://api.stripe.com/v1/invoices/@ID@/finalize" + Chr(34))
        CkStringBuilder::ckAppend(cmd," -u " + Chr(34) + "@KEY@:" + Chr(34))
        CkStringBuilder::ckAppend(cmd," -H " + Chr(34) + "Stripe-Version: 2026-10-28.endive" + Chr(34))
        CkStringBuilder::ckAppend(cmd," -H " + Chr(34) + "Idempotency-Key: @OP@-finalize" + Chr(34))
        CkStringBuilder::ckAppend(cmd," -d " + Chr(34) + "auto_advance=false" + Chr(34))
        replaced = CkStringBuilder::ckReplace(cmd,"@ID@",invoiceId)
        replaced = CkStringBuilder::ckReplace(cmd,"@OP@",operationId)
        replaced = CkStringBuilder::ckReplace(cmd,"@KEY@",apiKey)
        success = CkHttpCurl::ckDoYourThing(curl,CkStringBuilder::ckGetAsString(cmd))
        If success <> 1
            Debug "No HTTP response. Chilkat failure code: " + Str(CkHttpCurl::ckFailReason(curl))
            CkHttpCurl::ckDispose(curl)
            CkStringBuilder::ckDispose(cmd)
            CkJsonObject::ckDispose(json)
            ProcedureReturn
        EndIf

        success = CkHttpCurl::ckGetResponseJson(curl,json)
        If (CkHttpCurl::ckStatusCode(curl) <> 200) OR (success <> 1)
            Debug "Stripe HTTP " + Str(CkHttpCurl::ckStatusCode(curl)) + "  Request-Id: " + CkHttpCurl::ckGetResponseHeaderField(curl,"Request-Id")
            If success = 1
                Debug CkJsonObject::ckStringOf(json,"error.message")
            EndIf

            CkHttpCurl::ckDispose(curl)
            CkStringBuilder::ckDispose(cmd)
            CkJsonObject::ckDispose(json)
            ProcedureReturn
        EndIf

    EndIf

    If CkJsonObject::ckStringOf(json,"status") <> "open"
        Debug "Invoice is not open for collection: " + CkJsonObject::ckStringOf(json,"status")
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(cmd)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    ;  Retry a send using the same saved operation UUID. Test mode sends no email.

    ;  curl -X POST "https://api.stripe.com/v1/invoices/{invoiceId}/send" \
    ;    -u "$STRIPE_API_KEY:" \
    ;    -H "Stripe-Version: 2026-10-28.endive" \
    ;    -H "Idempotency-Key: {operationId}-send"
    CkStringBuilder::ckSetString(cmd,"curl -X POST " + Chr(34) + "https://api.stripe.com/v1/invoices/@ID@/send" + Chr(34))
    CkStringBuilder::ckAppend(cmd," -u " + Chr(34) + "@KEY@:" + Chr(34))
    CkStringBuilder::ckAppend(cmd," -H " + Chr(34) + "Stripe-Version: 2026-10-28.endive" + Chr(34))
    CkStringBuilder::ckAppend(cmd," -H " + Chr(34) + "Idempotency-Key: @OP@-send" + Chr(34))
    replaced = CkStringBuilder::ckReplace(cmd,"@ID@",invoiceId)
    replaced = CkStringBuilder::ckReplace(cmd,"@OP@",operationId)
    replaced = CkStringBuilder::ckReplace(cmd,"@KEY@",apiKey)
    success = CkHttpCurl::ckDoYourThing(curl,CkStringBuilder::ckGetAsString(cmd))
    If success <> 1
        Debug "No HTTP response. Chilkat failure code: " + Str(CkHttpCurl::ckFailReason(curl))
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(cmd)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    success = CkHttpCurl::ckGetResponseJson(curl,json)
    If (CkHttpCurl::ckStatusCode(curl) <> 200) OR (success <> 1)
        Debug "Stripe HTTP " + Str(CkHttpCurl::ckStatusCode(curl)) + "  Request-Id: " + CkHttpCurl::ckGetResponseHeaderField(curl,"Request-Id")
        If success = 1
            Debug CkJsonObject::ckStringOf(json,"error.message")
        EndIf

        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(cmd)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug "number = " + CkJsonObject::ckStringOf(json,"number")
    Debug "status = " + CkJsonObject::ckStringOf(json,"status")
    Debug "hosted_invoice_url = " + CkJsonObject::ckStringOf(json,"hosted_invoice_url")


    CkHttpCurl::ckDispose(curl)
    CkStringBuilder::ckDispose(cmd)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure