# GET /transactions/{transaction_id} **Get a transaction** Returns a transaction using its ID. Use the `include` parameter to include related entities in the response. **Required permissions:** `transaction.read` ## Path parameters | Name | Type | Required | Description | | --- | --- | --- | --- | | `transaction_id` | string | required | Paddle ID of the transaction entity to work with. | ## Query parameters | Name | Type | Required | Description | | --- | --- | --- | --- | | `include` | array | optional | Include related entities in the response. Use a comma-separated list to specify multiple entities. | ## Response (200) - `data`: object (required) — Represents a transaction entity with included entities. - `id`: string (required) — Unique Paddle ID for this transaction entity, prefixed with `txn_`. (pattern: `^txn_[a-z\d]{26}$`) - `status`: string (required) — 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. - `customer_id` (required) — Paddle ID of the customer that this transaction is for, prefixed with `ctm_`. - `address_id` (required) — Paddle ID of the address that this transaction is for, prefixed with `add_`. - `business_id` (required) — Paddle ID of the business that this transaction is for, prefixed with `biz_`. - `custom_data` (required) — Your own structured key-value data. - `currency_code`: string (required) — Supported three-letter ISO 4217 currency code. Must be `USD`, `EUR`, or `GBP` if `collection_mode` is `manual`. - `origin` (required) — Describes how this transaction was created. - `subscription_id` (required) — Paddle ID of the subscription that this transaction is for, prefixed with `sub_`. - `invoice_id` (required) — 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. (pattern: `^inv_[a-z\d]{26}$`) - `invoice_number` (required) — Invoice number for this transaction. Automatically generated by Paddle when you mark a transaction as `billed` where `collection_mode` is `manual`. - `collection_mode`: string (required) — How payment is collected for this transaction. `automatic` for checkout, `manual` for invoices. - `discount_id` (required) — Paddle ID of the discount applied to this transaction, prefixed with `dsc_`. - `billing_details` (required) — Details for invoicing. Required if `collection_mode` is `manual`. - `billing_period` (required) — Time period that this transaction is for. Set automatically by Paddle for subscription renewals to describe the period that charges are for. - `items`: array (required) — List of items on this transaction. For calculated totals, use `details.line_items`. (Items: 1–100) - `details`: object (required) — Calculated totals for a transaction, including proration, discounts, tax, and currency conversion. Considered the source of truth for totals on a transaction. - `tax_rates_used`: array (required) — List of tax rates applied for this transaction. - `totals`: object (required) — Breakdown of the total for a transaction. These numbers can be negative when dealing with subscription updates that result in credit. - `subtotal`: string (required) — Subtotal before discount, tax, and deductions. If an item, unit price multiplied by quantity. - `discount`: string (required) — Total discount as a result of any discounts applied. Except for percentage discounts, Paddle applies tax to discounts based on the line item `price.tax_mode`. If `price.tax_mode` for a line item is `internal`, Paddle removes tax from the discount applied. - `tax`: string (required) — Total tax on the subtotal. - `total`: string (required) — Total after discount and tax. - `credit`: string (required) — Total credit applied to this transaction. This includes credits applied using a customer's credit balance and adjustments to a `billed` transaction. - `credit_to_balance`: string (required) — Additional credit generated from negative `details.line_items`. This credit is added to the customer balance. - `balance`: string (required) — Total due on a transaction after credits and any payments. - `grand_total`: string (required) — Total due on a transaction after credits but before any payments. - `grand_total_tax`: string (required) — Net tax amount included in `grand_total`. Equals the full `tax` amount unless credits are applied, in which case this value is proportionally reduced. - `fee` (required) — Total fee taken by Paddle for this transaction. `null` until the transaction is `completed` and the fee is processed. - `earnings` (required) — Total earnings for this transaction. This is the total minus the Paddle fee. `null` until the transaction is `completed` and the fee is processed. - `currency_code`: string (required) — Three-letter ISO 4217 currency code of the currency used for this transaction. - `adjusted_totals`: object (required) — Breakdown of the totals for a transaction after adjustments. - `subtotal`: string (required) — Subtotal before discount, tax, and deductions. If an item, unit price multiplied by quantity. - `tax`: string (required) — Total tax on the subtotal. - `total`: string (required) — Total after tax. - `grand_total`: string (required) — Total due after credits but before any payments. - `grand_total_tax`: string (required) — Net tax amount included in `grand_total`. Equals the full `tax` amount unless credits are applied, in which case this value is proportionally reduced. - `fee` (required) — Total fee taken by Paddle for this transaction. `null` until the transaction is `completed` and the fee is processed. - `retained_fee`: string (required) — Total Paddle fees retained for this adjustment. - `earnings` (required) — Total earnings for this transaction. This is the total minus the Paddle fee. `null` until the transaction is `completed` and the fee is processed. - `currency_code`: string (required) — Three-letter ISO 4217 currency code of the currency used for this transaction. - `payout_totals` (required) — Breakdown of the payout total for a transaction. `null` until the transaction is `completed`. Returned in your payout currency. - `adjusted_payout_totals` (required) — Breakdown of the payout total for a transaction after adjustments. `null` until the transaction is `completed`. - `line_items`: array (required) — Information about line items for this transaction. Different from transaction `items` as they include totals calculated by Paddle. Considered the source of truth for line item totals. - `payments`: array (required) — List of payment attempts for this transaction, including successful payments. Sorted by `created_at` in descending order, so most recent attempts are returned first. - `checkout` (required) - `created_at`: string (date-time) (required) — RFC 3339 datetime string of when this entity was created. Set automatically by Paddle. - `updated_at`: string (date-time) (required) — RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle. - `billed_at` (required) — RFC 3339 datetime string of when this transaction was marked as `billed`. `null` for transactions that aren't `billed` or `completed`. Set automatically by Paddle. - `revised_at` (required) — RFC 3339 datetime string of when a transaction was revised. Revisions describe an update to customer information for a billed or completed transaction. `null` if not revised. Set automatically by Paddle. - `address`: object — Address for this transaction. Reflects the entity at the time it was added to the transaction, or its revision if `revised_at` is not `null`. Returned when the `include` parameter is used with the `address` value and the transaction has an `address_id`. - `id`: string (required) — Unique Paddle ID for this address entity, prefixed with `add_`. (pattern: `^add_[a-z\d]{26}$`) - `customer_id`: string (required) — Paddle ID for the customer related to this address, prefixed with `cus_`. (pattern: `^ctm_[a-z\d]{26}$`) - `description` (required) - `first_line` (required) - `second_line` (required) - `city` (required) - `postal_code` (required) - `region` (required) - `country_code` (required) — Supported two-letter ISO 3166-1 alpha-2 country code for this address. - `custom_data` (required) — Your own structured key-value data. - `status`: string (required) — Whether this entity can be used in Paddle. - `created_at`: string (date-time) (required) — RFC 3339 datetime string of when this entity was created. Set automatically by Paddle. - `updated_at`: string (date-time) (required) — RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle. - `import_meta` (required) - `adjustments`: array — List of adjustments for this transaction. Returned when the `include` parameter is used with the `adjustment` value and the transaction has adjustments. - `adjustments_totals`: object — Object containing totals for all adjustments on a transaction. Returned when the `include` parameter is used with the `adjustments_totals` value. - `subtotal`: string (required) — Total before tax. - `tax`: string (required) — Total tax on the subtotal. - `total`: string (required) — Total after tax. - `fee`: string (required) — Total fee taken by Paddle. - `retained_fee`: string (required) — Total gateway fee retained by Paddle. - `earnings`: string (required) — Total earnings. This is the subtotal minus the Paddle fee. For tax adjustments, this value is negative, which means a positive effect in the transaction earnings. This is because the fee is originally calculated from the transaction total, so if a tax adjustment is made, then the fee portion of it is returned. As a result, the earnings from all the adjustments performed could be either negative, positive or zero. - `breakdown`: object (required) — Breakdown of the total adjustments by adjustment action. - `credit`: string (required) — Total amount of credit adjustments. - `refund`: string (required) — Total amount of refund adjustments. - `chargeback`: string (required) — Total amount of chargeback adjustments. - `currency_code`: string (required) — Three-letter ISO 4217 currency code used for adjustments for this transaction. - `business`: object — Business for this transaction. Reflects the entity at the time it was added to the transaction, or its revision if `revised_at` is not `null`. Returned when the `include` parameter is used with the `business` value and the transaction has a `business_id`. - `id`: string (required) — Unique Paddle ID for this business entity, prefixed with `biz_`. (pattern: `^biz_[a-z\d]{26}$`) - `customer_id`: string (required) — Paddle ID for the customer related to this business, prefixed with `cus_`. (pattern: `^ctm_[a-z\d]{26}$`) - `name`: string (required) — Name of this business. (Length: 1–1024) - `company_number` (required) — Company number for this business. (Max length: 1024) - `tax_identifier` (required) — Tax or VAT Number for this business. (Max length: 1024) - `status`: string (required) — Whether this entity can be used in Paddle. - `contacts`: array (required) — List of contacts related to this business, typically used for sending invoices. (Items: max 100, unique) - `created_at`: string (date-time) (required) — RFC 3339 datetime string of when this entity was created. Set automatically by Paddle. - `updated_at`: string (date-time) (required) — RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle. - `custom_data` (required) — Your own structured key-value data. - `import_meta` (required) — Import information for this entity. `null` if this entity is not imported. - `customer`: object — Customer for this transaction. Reflects the entity at the time it was added to the transaction, or its revision if `revised_at` is not `null`. Returned when the `include` parameter is used with the `customer` value and the transaction has a `customer_id`. - `id`: string (required) — Unique Paddle ID for this customer entity, prefixed with `ctm_`. (pattern: `^ctm_[a-z\d]{26}$`) - `name` (required) — Full name of this customer. Required when creating transactions where `collection_mode` is `manual` (invoices). - `email`: string (email) (required) — Email address for this customer. (Length: 1–320) - `marketing_consent`: boolean (required) — Whether this customer opted into marketing from you. `false` unless customers check the marketing consent box when using Paddle Checkout. Set automatically by Paddle. - `status`: string (required) — Whether this entity can be used in Paddle. - `custom_data` (required) — Your own structured key-value data. - `locale`: string (required) — Valid IETF BCP 47 short form locale tag. If omitted, defaults to `en`. - `created_at`: string (date-time) (required) — RFC 3339 datetime string of when this entity was created. Set automatically by Paddle. - `updated_at`: string (date-time) (required) — RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle. - `import_meta` (required) — Import information for this entity. `null` if this entity is not imported. - `discount`: object — Discount for this transaction. Reflects the entity at the time it was added to the transaction. Returned when the `include` parameter is used with the `discount` value and the transaction has a `discount_id`. - `id`: string (required) — Unique Paddle ID for this discount, prefixed with `dsc_`. (pattern: `^dsc_[a-z\d]{26}$`) - `status`: string (required) — Whether this entity can be used in Paddle. - `description`: string (required) — Short description for this discount for your reference. Not shown to customers. (Length: 1–500) - `enabled_for_checkout`: boolean (required) — Whether this discount can be redeemed by customers at checkout (`true`) or not (`false`). - `code` (required) — Unique code that customers can use to redeem this discount at checkout. Not case-sensitive. - `type`: string (required) — Type of discount. Determines how this discount impacts the checkout or transaction total. - `mode`: string (required) — Discount mode. Standard discounts are considered part of your catalog and are shown in the Paddle dashboard. - `amount`: string (required) — Amount to discount by. For `percentage` discounts, must be an amount between `0.01` and `100`. For `flat` and `flat_per_seat` discounts, amount in the lowest denomination for a currency. - `currency_code` (required) — Supported three-letter ISO 4217 currency code. Required where discount type is `flat` or `flat_per_seat`. - `recur`: boolean (required) — Whether this discount applies for multiple subscription billing periods (`true`) or not (`false`). - `maximum_recurring_intervals` (required) — Number of subscription billing periods that this discount recurs for. Requires `recur`. `null` if this discount recurs forever. Subscription renewals, midcycle changes, and one-time charges billed to a subscription aren't considered a redemption. `times_used` is not incremented in these cases. (Min: 1) - `usage_limit` (required) — Maximum number of times this discount can be redeemed. This is an overall limit for this discount, rather than a per-customer limit. `null` if this discount can be redeemed an unlimited amount of times. Paddle counts a usage as a redemption on a checkout, transaction, or the initial application against a subscription. Transactions created for subscription renewals, midcycle changes, and one-time charges aren't considered a redemption. (Min: 1) - `restrict_to` (required) — Product or price IDs that this discount is for. When including a product ID, all prices for that product can be discounted. `null` if this discount applies to all products and prices. (Items: unique) - `expires_at` (required) — RFC 3339 datetime string of when this discount expires. Discount can no longer be redeemed after this date has elapsed. `null` if this discount can be redeemed forever. Expired discounts can't be redeemed against transactions or checkouts, but can be applied when updating subscriptions. - `custom_data` (required) - `times_used`: integer (required) — How many times this discount has been redeemed. Automatically incremented by Paddle. Paddle counts a usage as a redemption on a checkout, transaction, or subscription. Transactions created for subscription renewals, midcycle changes, and one-time charges aren't considered a redemption. - `discount_group_id` (required) — Paddle ID for the discount group related to this discount, prefixed with `dsg_`. `null` if not in a discount group. - `created_at`: string (date-time) (required) — RFC 3339 datetime string of when this entity was created. Set automatically by Paddle. - `updated_at`: string (date-time) (required) — RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle. - `import_meta` (required) — Import information for this entity. `null` if this entity is not imported. - `available_payment_methods`: array — List of available payment methods for this transaction. Returned when the `include` parameter is used with the `available_payment_methods` value. - `meta`: object (required) — Information about this response. - `request_id`: string (required) — Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request. ### Response example ```json { "data": { "id": "txn_01hv8wptq8987qeep44cyrewp9", "status": "completed", "customer_id": "ctm_01hv8wt8nffez4p2t6typn4a5j", "address_id": "add_01hv8wt8ny8ms5vtm71bj8vcdd", "business_id": null, "custom_data": null, "origin": "web", "collection_mode": "automatic", "subscription_id": "sub_01hv8x29kz0t586xy6zn1a62ny", "invoice_id": "inv_01hv8x29nsh54c2pgt0hnq0zkx", "invoice_number": "325-10566", "billing_details": null, "billing_period": { "starts_at": "2024-04-12T10:18:47.635628Z", "ends_at": "2024-05-12T10:18:47.635628Z" }, "currency_code": "USD", "discount_id": null, "created_at": "2024-04-12T10:12:33.2014Z", "updated_at": "2024-04-12T10:20:21.386946Z", "billed_at": "2024-04-12T10:18:48.294633Z", "revised_at": null, "items": [ { "price": { "id": "pri_01gsz8x8sawmvhz1pv30nge1ke", "description": "Monthly", "type": "standard", "name": "Monthly (per seat)", "product_id": "pro_01gsz4t5hdjse780zja8vvr7jg", "billing_cycle": { "interval": "month", "frequency": 1 }, "trial_period": null, "tax_mode": "account_setting", "unit_price": { "amount": "3000", "currency_code": "USD" }, "unit_price_overrides": [], "custom_data": null, "quantity": { "minimum": 1, "maximum": 999 }, "status": "active", "created_at": "2023-02-23T13:55:22.538367Z", "updated_at": "2024-04-11T13:54:52.254748Z", "import_meta": null }, "quantity": 10, "proration": null }, { "price": { "id": "pri_01h1vjfevh5etwq3rb416a23h2", "description": "Monthly", "type": "standard", "name": "Monthly (recurring addon)", "product_id": "pro_01h1vjes1y163xfj1rh1tkfb65", "billing_cycle": { "interval": "month", "frequency": 1 }, "trial_period": null, "tax_mode": "account_setting", "unit_price": { "amount": "10000", "currency_code": "USD" }, "unit_price_overrides": [], "custom_data": null, "quantity": { "minimum": 1, "maximum": 100 }, "status": "active", "created_at": "2023-06-01T13:31:12.625056Z", "updated_at": "2024-04-09T07:23:00.907834Z", "import_meta": null }, "quantity": 1, "proration": null }, { "price": { "id": "pri_01gsz98e27ak2tyhexptwc58yk", "description": "One-time addon", "type": "standard", "name": "One-time addon", "product_id": "pro_01gsz97mq9pa4fkyy0wqenepkz", "billing_cycle": null, "trial_period": null, "tax_mode": "account_setting", "unit_price": { "amount": "19900", "currency_code": "USD" }, "unit_price_overrides": [], "custom_data": null, "quantity": { "minimum": 1, "maximum": 1 }, "status": "active", "created_at": "2023-02-23T14:01:28.391712Z", "updated_at": "2024-04-09T07:23:10.921392Z", "import_meta": null }, "quantity": 1, "proration": null } ], "details": { "tax_rates_used": [ { "tax_rate": "0.08875", "totals": { "subtotal": "59900", "discount": "0", "tax": "5315", "total": "65215" } } ], "totals": { "subtotal": "59900", "tax": "5315", "discount": "0", "total": "65215", "grand_total": "65215", "grand_total_tax": "5315", "fee": "3311", "credit": "0", "credit_to_balance": "0", "balance": "0", "earnings": "56589", "currency_code": "USD" }, "adjusted_totals": { "subtotal": "59900", "tax": "5315", "total": "65215", "grand_total": "65215", "grand_total_tax": "5315", "fee": "3311", "earnings": "56589", "currency_code": "USD", "retained_fee": "0" }, "payout_totals": { "subtotal": "59900", "discount": "0", "tax": "5315", "total": "65215", "credit": "0", "credit_to_balance": "0", "balance": "0", "grand_total": "65215", "grand_total_tax": "5315", "fee": "3311", "earnings": "56589", "currency_code": "USD", "exchange_rate": "1", "fee_rate": "0.05" }, "adjusted_payout_totals": { "subtotal": "59900", "tax": "5315", "total": "65215", "fee": "3311", "retained_fee": "0", "chargeback_fee": { "amount": "0", "original": null }, "earnings": "56589", "currency_code": "USD", "exchange_rate": "1" }, "line_items": [ { "id": "txnitm_01hv8wt98jahpbm1t1tzr06z6n", "price_id": "pri_01gsz8x8sawmvhz1pv30nge1ke", "quantity": 10, "totals": { "subtotal": "30000", "tax": "2662", "discount": "0", "total": "32662" }, "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.", "type": "standard", "tax_category": "standard", "image_url": "https://paddle.s3.amazonaws.com/user/165798/bT1XUOJAQhOUxGs83cbk_pro.png", "custom_data": { "features": { "aircraft_performance": true, "compliance_monitoring": true, "flight_log_management": true, "payment_by_invoice": false, "route_planning": true, "sso": false }, "suggested_addons": [ "pro_01h1vjes1y163xfj1rh1tkfb65", "pro_01gsz97mq9pa4fkyy0wqenepkz" ], "upgrade_description": "Move from Basic to Pro to take advantage of aircraft performance, advanced route planning, and compliance monitoring." }, "status": "active", "created_at": "2023-02-23T12:43:46.605Z", "updated_at": "2024-04-05T15:53:44.687Z", "import_meta": null }, "tax_rate": "0.08875", "unit_totals": { "subtotal": "3000", "tax": "266", "discount": "0", "total": "3266" }, "proration": null }, { "id": "txnitm_01hv8wt98jahpbm1t1v1sd067y", "price_id": "pri_01h1vjfevh5etwq3rb416a23h2", "quantity": 1, "totals": { "subtotal": "10000", "tax": "887", "discount": "0", "total": "10887" }, "product": { "id": "pro_01h1vjes1y163xfj1rh1tkfb65", "name": "Analytics addon", "description": "Unlock advanced insights into your flight data with enhanced analytics and reporting features. Includes customizable reporting templates and trend analysis across flights.", "type": "standard", "tax_category": "standard", "image_url": "https://paddle.s3.amazonaws.com/user/165798/97dRpA6SXzcE6ekK9CAr_analytics.png", "custom_data": null, "status": "active", "created_at": "2023-06-01T13:30:50.302Z", "updated_at": "2024-04-05T15:47:17.163Z", "import_meta": null }, "tax_rate": "0.08875", "unit_totals": { "subtotal": "10000", "tax": "887", "discount": "0", "total": "10887" }, "proration": null }, { "id": "txnitm_01hv8wt98jahpbm1t1v67vqnb6", "price_id": "pri_01gsz98e27ak2tyhexptwc58yk", "quantity": 1, "totals": { "subtotal": "19900", "tax": "1766", "discount": "0", "total": "21666" }, "product": { "id": "pro_01gsz97mq9pa4fkyy0wqenepkz", "name": "Custom domains", "description": "Make AeroEdit truly your own with custom domains. Custom domains reinforce your brand identity and make it easy for your team to access your account.", "type": "standard", "tax_category": "standard", "image_url": "https://paddle.s3.amazonaws.com/user/165798/XIG7UXoJQHmlIAiKcnkA_custom-domains.png", "custom_data": null, "status": "active", "created_at": "2023-02-23T14:01:02.441Z", "updated_at": "2024-04-05T15:43:28.971Z", "import_meta": null }, "tax_rate": "0.08875", "unit_totals": { "subtotal": "19900", "tax": "1766", "discount": "0", "total": "21666" }, "proration": null } ] }, "payments": [ { "payment_attempt_id": "937640dd-e3dc-40df-a16c-bb75aafd8f71", "stored_payment_method_id": "281ff2ca-8550-42b9-bf39-15948e7de62d", "payment_method_id": "paymtd_01hv8x1tpjfnttxddw73xnqx6s", "amount": "65215", "status": "captured", "error_code": null, "method_details": { "type": "card", "underlying_details": null, "south_korea_local_card": null, "card": { "type": "visa", "last4": "3184", "expiry_month": 1, "expiry_year": 2025, "cardholder_name": "Michael McGovern" }, "paypal": null }, "created_at": "2024-04-12T10:18:33.579142Z", "captured_at": "2024-04-12T10:18:47.635628Z" }, { "payment_attempt_id": "8f72cfa6-26b4-4a57-91dc-8f2708f7822d", "stored_payment_method_id": "a78ece50-356f-4e0c-b72d-ad5368b0a0d9", "payment_method_id": "paymtd_01hv8wx2mka7dfsqjjsxh1ne7z", "amount": "65215", "status": "error", "error_code": "declined", "method_details": { "type": "card", "underlying_details": null, "south_korea_local_card": null, "card": { "type": "visa", "last4": "0002", "expiry_month": 1, "expiry_year": 2025, "cardholder_name": "Michael McGovern" }, "paypal": null }, "created_at": "2024-04-12T10:15:57.888183Z", "captured_at": null } ], "checkout": { "url": "https://aeroedit.com/pay?_ptxn=txn_01hv8wptq8987qeep44cyrewp9" } }, "meta": { "request_id": "d6186f6a-70f7-4f1c-a65a-f790f940cf6e" } } ```