Sample code for 30+ languages & platforms
CkPython Requires Chilkat v11.0.0+

PayPal: Revise a draft invoice from its full billing record

See more PayPal Examples

PUT replaces the invoice. This example revises the quantity on the simple two-inspection draft to three. Rebuild the complete editable document from your billing record; omitted items, terms or recipients can be lost. Do not use this body for an unrelated invoice.

PayPal documentation

Chilkat CkPython Downloads

CkPython
import sys
import chilkat

success = False

#  See Unlock Chilkat before making requests.
#  For the merchant's internal backoffice application. Load the sandbox token
#  from the merchant's credential store. Keep it out of publicly distributed apps.
#  See Get a PayPal access token.
http = chilkat.CkHttp()
http.put_AuthToken("SANDBOX_ACCESS_TOKEN")
resp = chilkat.CkHttpResponse()

#  Use only the ID of the matching draft from the create example, while it is still a
#  draft. Preserve all of your real draft fields, including any custom invoice number.
http.SetUrlVar("id","INVOICE_ID")
http.SetRequestHeader("Prefer","return=representation")
body = chilkat.CkJsonObject()
body.UpdateString("detail.currency_code","USD")
body.UpdateString("detail.payment_term.term_type","NET_30")
body.UpdateString("primary_recipients[0].billing_info.email_address","buyer@example.com")
body.UpdateString("items[0].name","Equipment inspection")
body.UpdateString("items[0].quantity","3")
body.UpdateString("items[0].unit_amount.currency_code","USD")
body.UpdateString("items[0].unit_amount.value","45.00")

success = http.HttpJson("PUT","https://api-m.sandbox.paypal.com/v2/invoicing/invoices/{$id}",body,"application/json",resp)
if (success != True):
    print("No HTTP response: " + http.lastErrorText())
    sys.exit()

if ((resp.get_StatusCode() < 200) or (resp.get_StatusCode() >= 300)):
    errorInfo = chilkat.CkJsonObject()
    errorInfo.Load(resp.bodyStr())
    print("HTTP " + str(resp.get_StatusCode()) + " " + errorInfo.stringOf("name") + " " + errorInfo.stringOf("details[0].issue"))
    print("PayPal debug ID: " + errorInfo.stringOf("debug_id"))
    sys.exit()

result = chilkat.CkJsonObject()
parsed = result.Load(resp.bodyStr())
if (parsed != True):
    print("Expected a JSON response; HTTP " + str(resp.get_StatusCode()))
    sys.exit()

print("ID: " + result.stringOf("id"))
print("Status: " + result.stringOf("status"))
print("New total: " + result.stringOf("amount.value"))
print("Currency: " + result.stringOf("amount.currency_code"))