transaction.created
Occurs when a transaction is created. Paddle creates a transaction when:
- Customers open checkout.
- You create an invoice in the Paddle web app.
You may also create a transaction using the API:
- Create a manually-collected transaction to create and send an invoice.
- Create an automatically-collected transaction and pass to a checkout to collect for payment.
Where a transaction has items
, customer_id
, and address_id
, transaction.ready
occurs immediately after.
Unique Paddle ID for this event, prefixed with evt_
.
Type of event sent by Paddle, in the format entity.event_type
.
RFC 3339 datetime string of when this event occurred.
New or changed entity.
Unique Paddle ID for this transaction entity, prefixed with txn_
.
Status of this transaction. You may set a transaction to billed
or canceled
, other statuses are set automatically by Paddle. Automatically-collected transactions may return completed
if payment is captured successfully, or past_due
if payment failed.
Paddle ID of the customer that this transaction is for, prefixed with ctm_
.
Paddle ID of the address that this transaction is for, prefixed with add_
.
Paddle ID of the business that this transaction is for, prefixed with biz_
.
Your own structured key-value data.
Supported three-letter ISO 4217 currency code. Must be USD
, EUR
, or GBP
if collection_mode
is manual
.
Describes how this transaction was created.
Paddle ID of the subscription that this transaction is for, prefixed with sub_
.
Paddle ID of the invoice that this transaction is related to, prefixed with inv_
. Used for compatibility with the Paddle Invoice API, which is now deprecated. This field is scheduled to be removed in the next version of the Paddle API.
Invoice number for this transaction. Automatically generated by Paddle when you mark a transaction as billed
where collection_mode
is manual
.
How payment is collected for this transaction. automatic
for checkout, manual
for invoices.
Paddle ID of the discount applied to this transaction, prefixed with dsc_
.
Details for invoicing. Required if collection_mode
is manual
.
Time period that this transaction is for. Set automatically by Paddle for subscription renewals to describe the period that charges are for.
List of items on this transaction. For calculated totals, use details.line_items
.
Calculated totals for a transaction, including proration, discounts, tax, and currency conversion. Considered the source of truth for totals on a transaction.
List of payment attempts for this transaction, including successful payments. Sorted by created_at
in descending order, so most recent attempts are returned first.
Paddle Checkout details for this transaction. Returned for automatically-collected transactions and where billing_details.enable_checkout
is true
for manually-collected transactions; null
otherwise.
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
RFC 3339 datetime string of when this transaction was marked as billed
. null
for transactions that are not billed
or completed
. Set automatically by Paddle.
Unique Paddle ID for this notification, prefixed with ntf_
.
12345678910111213141516171819201{
2 "event_id": "evt_01hv8wpv7nkct05j2zxxvpz6dm",
3 "event_type": "transaction.created",
4 "occurred_at": "2024-04-12T10:12:33.653418Z",
5 "notification_id": "ntf_01hv8wpva216nz1ykxf3m3vwyr",
6 "data": {
7 "id": "txn_01hv8wptq8987qeep44cyrewp9",
8 "items": [
9 {
10 "price": {
11 "id": "pri_01gsz8x8sawmvhz1pv30nge1ke",
12 "name": "Monthly (per seat)",
13 "type": "standard",
14 "status": "active",
15 "quantity": {
16 "maximum": 999,
17 "minimum": 1
18 },
19 "tax_mode": "account_setting",
20 "created_at": "2023-02-23T13:55:22.538367Z",