Docs

checkout.completed

Emitted when a checkout is completed successfully.

Use checkout.completed to run actions when a checkout is completed successfully. This typically means:

  • For instant capture payment methods, payment was taken successfully for the items on a checkout.
  • For deferred capture payment methods, payment was authorized and is pending capture.
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.
Values
  • draft
    Checkout missing required fields to process a payment. Typically the first stage of a checkout before customer details are captured.
  • ready
    Checkout transaction has all of the required fields to process a payment.
  • billed
    Related transaction for this checkout is billed. Billed transactions get an invoice number and are considered a legal record. They cannot be changed. Typically used as part of an invoice workflow. May be present at checkout when a customer is paying an invoice using Paddle Checkout link.
  • paid
    Related transaction for this checkout is fully paid, but has not yet been processed internally. Not typically encountered at checkout.
  • completed
    Checkout is completed. Typically means payment collected successfully.
+ Show all values
  • canceled
    Related transaction for this checkout is canceled. Not typically encountered at checkout.
  • past_due
    Typically means the related transaction is past_due. May be present at checkout when updating payment details to collect for an overdue payment.
custom_dataobject | 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.
idstring | null
Unique Paddle ID for the customer related to this checkout, prefixed with ctm_.
emailstring | null
Email address for the customer.
addressobject | null
Information about the customer billing address on this checkout.
idstring
Unique Paddle ID for the address related to this checkout, prefixed with add_.
country_codestring
Two-letter ISO 3166 country code.
postal_codestring
ZIP or postal code of the customer billing address. Required for countries with postal codes.
first_linestring
First line of the customer billing address.
citystring
City of the customer billing address.
regionstring
State, county, or region of the customer billing address.
businessobject | null
Information about the customer business on this checkout.
idstring
Unique Paddle ID for the business related to this checkout, prefixed with biz_.
namestring
Name of this business.
tax_identifierstring
Tax or VAT Number for this business.
itemsarray
Items to bill for.
price_idstring
Unique Paddle ID for a price to bill for, prefixed with pri_.
price_namestring | null
Name of this price, shown to customers at checkout. Typically describes how often the related product bills.
productobject
Related product object for this price.
idstring
Unique Paddle ID for the product related to the price on this checkout, prefixed with pro_.
namestring
Name of this product.
descriptionstring | null
Short description for this product. Included on some customer documents, like receipts.
image_urlstring | null
Image for this product. Included in the overlay checkout and on some receipts.
billing_cycleobject | null
How often this items bills.
intervalstring
Period of recurrence.
Values
  • day
    Billed daily.
  • week
    Billed weekly.
  • month
    Billed monthly.
  • year
    Billed annually.
frequencyinteger
Frequency of recurrence in the period.
trial_periodobject | null
How long the trial period is for this item.
intervalstring
Period.
Values
  • day
    Day
  • week
    Week
  • month
    Month
  • year
    Year
frequencynumber
Frequency in the period.
quantityinteger
Quantity to bill for.
totalsobject
Financial breakdown of the total for this checkout item, calculated by Paddle.
subtotalnumber
Amount multiplied by quantity.
discountnumber
Total discount applied to this checkout.
taxnumber
Total tax on the subtotal.
totalnumber
Subtotal plus tax.
creditnumber
Total credit applied.
balancenumber
Total due after credits.
recurring_totalsobject
Financial breakdown of the recurring total for this checkout item, calculated by Paddle. Only included for recurring items.
subtotalnumber
Amount multiplied by quantity.
discountnumber
Total discount applied to this checkout.
taxnumber
Total tax on the subtotal.
totalnumber
Subtotal plus tax.
creditnumber
Total credit applied.
balancenumber
Total due after credits.
totalsobject
Financial breakdown of the total for this checkout, calculated by Paddle.
subtotalnumber
Amount multiplied by quantity.
discountnumber
Total discount applied to this checkout.
taxnumber
Total tax on the subtotal.
totalnumber
Subtotal plus tax.
creditnumber
Total credit applied.
balancenumber
Total due after credits.
recurring_totalsobject
Financial breakdown of the recurring total for this checkout, calculated by Paddle. Only included where there are recurring items.
subtotalnumber
Amount multiplied by quantity.
discountnumber
Total discount applied to this checkout.
taxnumber
Total tax on the subtotal.
totalnumber
Subtotal plus tax.
creditnumber
Total credit applied.
balancenumber
Total due after credits.
settingsobject
Checkout settings.
display_modestring
Display mode for the checkout.
Values
  • inline
    Inline checkout mode. Checkout embedded as a frame in the page. Requires settings.frameTarget in Paddle.Initialize()
  • wide-overlay
    Overlay checkout mode. Checkout opens in an overlay.
themestring
Theme for the checkout.
Values
  • dark
    Dark-themed checkout.
  • light
    Light-themed checkout.
variantstring
Checkout experience presented to customers.
Values
  • one-page
    One-page checkout experience. Customer information and payment details collected on the same page.
  • multi-page
    Multi-page checkout experience. Customer information and payment details collected on separate pages.
discountobject | null
Information about the discount applied to this checkout. Only included when a discount is applied.
idstring
Unique Paddle ID for the discount applied to this checkout, prefixed with dsc_.
codestring | null
Code for this discount.
upsellobject | null
Context about the rendered upsell checkout. null if an upsell flow was not rendered.
transaction_idstring
Unique Paddle ID for the previously completed transaction that this upsell follows, prefixed with txn_.
show_skip_buttonboolean
Whether the "No thanks" skip button is shown at checkout.
same_sessionboolean
Whether the checkout was created within 5 minutes of the previously completed transaction. Determines the checkout experience presented to the customer.
paymentobject
Information about the payment details used on this checkout.
method_detailsobject | null
Information about the payment method used for a payment attempt.
typestring
Type of payment method used.
Values
  • alipay
    Alipay, popular in China.
  • apple_pay
    Apple Pay on a supported Apple device.
  • bancontact
    Bancontact, popular in Belgium.
  • blik
    BLIK, a popular payment method in Poland.
  • card
    Credit or debit card.
+ Show all values
  • google_pay
    Google Pay on a supported Android device, Chromebook, or Google Chrome browser.
  • ideal
    iDEAL, popular in the Netherlands.
  • kakao_pay
    Kakao Pay, a popular payment method in Korea.
  • mb_way
    MB WAY, a popular payment method in Portugal.
  • naver_pay
    Naver Pay, a popular payment method in Korea.
  • none
    No payment method, or payment method not yet known.
  • payco
    Payco, a popular payment method in Korea.
  • paypal
    PayPal.
  • pix
    Pix, popular in Brazil. Available in early access.
  • samsung_pay
    Samsung Pay, a popular payment method in Korea.
  • south_korea_local_card
    Korean local credit or debit card.
  • unknown
    Payment method not known.
  • upi
    Unified Payments Interface (UPI), popular in India. Available in early access.
cardobject | null
Information about the card used for this checkout.
typestring
Type of credit or debit card used to pay.
Values
  • american_express
    American Express
  • diners_club
    Diners Club
  • discover
    Discover Card
  • jcb
    JCB Card
  • maestro
    Maestro (debit card)
+ Show all values
  • mastercard
    Mastercard
  • union_pay
    UnionPay, popular in China
  • visa
    Visa
  • unknown
    Card type unknown
last4string
Last four digits of the card number used.
expiry_monthinteger
Number of the month of the year that this card expires in the format MM.
expiry_yearinteger
Year that this card expires in the format YYYY.
Example
{
  "name": "checkout.completed",
  "data": {
    "id": "che_01k9ppwfg7nkr1s47pntfe7x3s",
    "transaction_id": "txn_01k9ppwf885xk7azx0xgnp6kp1",
    "status": "completed",
    "custom_data": null,
    "currency_code": "USD",
    "customer": {
      "id": "ctm_01k9pq1gzbza1n86n4jef18sbp",
      "email": "sam@example.com",
      "address": {
        "postal_code": "10021",
        "region": "",
        "country_code": "US",
        "id": "add_01k9pq6e149abgqb42rsebvvfw",
        "city": "",
        "first_line": ""
      },
      "business": null
    },
    "items": [
      {
        "price_id": "pri_01gsz8x8sawmvhz1pv30nge1ke",
        "price_name": "Monthly (per seat)",
        "product": {
          "id": "pro_01gsz4t5hdjse780zja8vvr7jg",
          "name": "AeroEdit Pro",
          "description": "Designed for professional pilots, including all features plus in Basic plus compliance monitoring, route optimization, and third-party integrations.",
          "image_url": "https://paddle.s3.amazonaws.com/user/165798/bT1XUOJAQhOUxGs83cbk_pro.png"
        },
        "billing_cycle": {
          "interval": "month",
          "frequency": 1
        },
        "trial_period": null,
        "quantity": 1,
        "totals": {
          "subtotal": 30,
          "tax": 2.66,
          "total": 32.66,
          "discount": 0,
          "balance": 32.66,
          "credit": 0
        },
        "recurring_totals": {
          "subtotal": 30,
          "tax": 2.66,
          "discount": 0,
          "total": 32.66
        }
      }
    ],
    "totals": {
      "subtotal": 30,
      "tax": 2.66,
      "total": 32.66,
      "discount": 0,
      "credit": 0,
      "balance": 0
    },
    "payment": {
      "method_details": {
        "type": "card",
        "card": {
          "type": "visa",
          "last4": "4242",
          "expiry_month": 10,
          "expiry_year": 2030
        }
      }
    },
    "settings": {
      "display_mode": "wide-overlay",
      "theme": "light",
      "variant": "one-page"
    },
    "recurring_totals": {
      "subtotal": 30,
      "tax": 2.66,
      "discount": 0,
      "total": 32.66,
      "balance": 32.66,
      "credit": 0
    },
    "upsell": {
      "transaction_id": "txn_01gzdn07vccpnwp1gwwnn2hy8r",
      "show_skip_button": true,
      "same_session": true
    }
  }
}

Was this page helpful?