checkout.upsell.canceled

Emitted when a checkout for an upsell is canceled.

This means the customer has clicked the "No thanks" skip button. You should handle this by redirecting, closing the checkout, or updating to reflect the skipped upsell.

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.

upsellobject or null

Context about the rendered upsell checkout. null if an upsell flow was not rendered.

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.upsell.canceled",
3  "data": {
4    "id": "che_01k9ppwfg7nkr1s47pntfe7x3s",
5    "transaction_id": "txn_01k9ppwf885xk7azx0xgnp6kp1",
6    "status": "draft",
7    "custom_data": null,
8    "currency_code": "USD",
9    "customer": {
10      "id": null,
11      "email": null,
12      "address": null,
13      "business": null
14    },
15    "items": [
16      {
17        "price_id": "pri_01gsz8x8sawmvhz1pv30nge1ke",
18        "price_name": "Monthly (per seat)",
19        "product": {
20          "id": "pro_01gsz4t5hdjse780zja8vvr7jg",

AI AssistantBeta

Ask a question to start a conversation!

If you have made a purchase through Paddle, go to paddle.net instead.

Protected by hCaptcha