Python Requires Chilkat v11.0.0+

PayPal: Cancel a sent, unpaid invoice

See more PayPal Examples

Cancel an unpaid invoice that has already been sent and notify the customer why. For a draft use delete instead. Cancellation does not return funds.

PayPal documentation

Python

import sys
import chilkat2

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 = chilkat2.Http()
http.AuthToken = "SANDBOX_ACCESS_TOKEN"
resp = chilkat2.HttpResponse()

# This cancels a sent, unpaid invoice. It does not send a refund.

http.SetUrlVar("id","INVOICE_ID")
body = chilkat2.JsonObject()
body.UpdateString("subject","Inspection invoice canceled")
body.UpdateString("note","The inspection was canceled before work began.")
body.UpdateBool("send_to_recipient",True)

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

if ((resp.StatusCode < 200) or (resp.StatusCode >= 300)):
    errorInfo = chilkat2.JsonObject()
    errorInfo.Load(resp.BodyStr)
    print("HTTP " + str(resp.StatusCode) + " " + errorInfo.StringOf("name") + " " + errorInfo.StringOf("details[0].issue"))
    print("PayPal debug ID: " + errorInfo.StringOf("debug_id"))
    sys.exit()

print("Cancellation accepted; HTTP " + str(resp.StatusCode))