invoice scheduled_charge_failed

EVENT

invoice.scheduled_charge_failed

Published when an automatic scheduled payment for an Invoice has failed.

Permissions:INVOICES_READ

Link to section

Event payload

Example code

Link to section

merchant_id

string

The ID of the target merchant associated with the event.

Link to section

type

string

The type of event this represents, "invoice.scheduled_charge_failed".

Link to section

event_id

string

A unique ID for the event.

Link to section

created_at

string

Read only Timestamp of when the event was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

data

Data associated with the event.

{ "merchant_id": "031FEV2Q6VMPK", "location_id": "ES0RJRZYEC39A", "type": "invoice.scheduled_charge_failed", "event_id": "3cabb64e-16ba-40c2-b605-5c51a06ec794", "created_at": "2020-06-18T18:23:11Z", "data": { "type": "invoice", "id": "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY", "object": { "invoice": { "id": "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY", "version": 4, "location_id": "ES0RJRZYEC39A", "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY", "payment_requests": [ { "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355", "request_type": "BALANCE", "due_date": "2030-01-24", "tipping_enabled": false, "automatic_payment_source": "NONE", "reminders": [ { "uid": "beebd363-e47f-4075-8785-c235aaa7df11", "relative_scheduled_days": -1, "message": "Your invoice is due tomorrow", "status": "PENDING" } ], "computed_amount_money": { "amount": 10000, "currency": "USD" }, "total_completed_amount_money": { "amount": 0, "currency": "USD" } } ], "invoice_number": "inv-100", "title": "Event Planning Services", "description": "We appreciate your business!", "delivery_method": "EMAIL", "scheduled_at": "2030-01-13T10:00:00Z", "status": "UNPAID", "timezone": "America/Los_Angeles", "created_at": "2020-06-18T17:45:13Z", "updated_at": "2020-06-18T18:23:11Z", "primary_recipient": { "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4", "given_name": "Amelia", "family_name": "Earhart", "email_address": "[email protected]", "phone_number": "1-212-555-4240" }, "accepted_payment_methods": { "card": true, "square_gift_card": false, "bank_account": false, "buy_now_pay_later": false, "cash_app_pay": false }, "custom_fields": [ { "label": "Event Reference Number", "value": "Ref. #1234", "placement": "ABOVE_LINE_ITEMS" }, { "label": "Terms of Service", "value": "The terms of service are...", "placement": "BELOW_LINE_ITEMS" } ], "next_payment_amount_money": { "amount": 10000, "currency": "USD" }, "sale_or_service_date": "2030-01-24", "store_payment_method_enabled": false } } } }