checkout.closed

Emitted when a checkout is closed. This typically means the customer clicked the close icon on an overlay checkout.

checkout.completed is emitted when payment is successful.

namestring

Name of this event, in the format entity.event_type.

dataobject

Event payload.

idstring

Unique Paddle ID for this checkout, prefixed with che_.

transaction_idstring

Unique Paddle ID for the transaction related to this checkout, prefixed with txn_.

statusstring

Status of this checkout.

custom_dataobject or null

Key-value pairs of custom data. Must be valid JSON and contain at least one key.

currency_codestring

Supported three-letter ISO 4217 currency code for this checkout.

customerobject

Information about the customer on this checkout.

itemsarray[object]

Items to bill for.

totalsobject

Financial breakdown of the total for this checkout, calculated by Paddle.

recurring_totalsobject

Financial breakdown of the recurring total for this checkout, calculated by Paddle. Only included where there are recurring items.

paymentobject

Information about the payment details used on this checkout.

settingsobject

Checkout settings.

discountobject or null

Information about the discount applied to this checkout. Only included when a discount is applied.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
1{
2  "name": "checkout.closed",
3  "data": {
4    "id": "che_01gzdn081y1xvax041javf6gcy",
5    "transaction_id": "txn_01gzdn07vccpnwp1gwwnn2hy8r",
6    "status": "draft",
7    "custom_data": null,
8    "currency_code": "GBP",
9    "customer": {
10      "id": null,
11      "email": null,
12      "address": null,
13      "business": null
14    },
15    "items": [
16      {
17        "price_id": "pri_01gsz8x8sawmvhz1pv30nge1ke",
18        "product": {
19          "id": "pro_01gsz4t5hdjse780zja8vvr7jg",
20          "name": "ChatApp Pro",