List transactions

gethttps://api.paddle.com/transactions

Returns a paginated list of transactions. Use the query parameters to page through results.

Use the include parameter to include related entities in the response.

Query Parameters

afterstring

Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.

billed_atstring

Return entities billed at a specific time. Pass an RFC 3339 datetime string, or use [LT] (less than), [LTE] (less than or equal to), [GT] (greater than), or [GTE] (greater than or equal to) operators. For example, billed_at=2023-04-18T17:03:26 or billed_at[LT]=2023-04-18T17:03:26.

collection_modestring

Return entities that match the specified collection mode.

created_atstring

Return entities created at a specific time. Pass an RFC 3339 datetime string, or use [LT] (less than), [LTE] (less than or equal to), [GT] (greater than), or [GTE] (greater than or equal to) operators. For example, created_at=2023-04-18T17:03:26 or created_at[LT]=2023-04-18T17:03:26.

customer_idarray[string]

Return entities related to the specified customer. Use a comma-separated list to specify multiple customer IDs.

idarray[string]

Return only the IDs specified. Use a comma-separated list to get multiple entities.

includearray[string]

Include related entities in the response. Use a comma-separated list to specify multiple entities.

invoice_numberarray[string]

Return entities that match the invoice number. Use a comma-separated list to specify multiple invoice numbers.

originarray[string]

Return entities related to the specified origin. Use a comma-separated list to specify multiple origins.

order_bystring

Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].

Valid fields for ordering: billed_at, created_at, id, and updated_at.

statusarray[string]

Return entities that match the specified status. Use a comma-separated list to specify multiple status values.

subscription_idarray[string]

Return entities related to the specified subscription. Use a comma-separated list to specify multiple subscription IDs. Pass null to return entities that are not related to any subscription.

per_pageinteger

Set how many entities are returned per page.

updated_atstring

Return entities updated at a specific time. Pass an RFC 3339 datetime string, or use [LT] (less than), [LTE] (less than or equal to), [GT] (greater than), or [GTE] (greater than or equal to) operators. For example, updated_at=2023-04-18T17:03:26 or updated_at[LT]=2023-04-18T17:03:26.

Response

dataarray[object]

Represents a transaction entity with included entities.

idstring

Unique Paddle ID for this transaction entity, prefixed with txn_.

statusstring

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_idstring or null

Paddle ID of the customer that this transaction is for, prefixed with ctm_.

address_idstring or null

Paddle ID of the address that this transaction is for, prefixed with add_.

business_idstring or null

Paddle ID of the business that this transaction is for, prefixed with biz_.

custom_dataobject or null

Your own structured key-value data.

currency_codestring

Supported three-letter ISO 4217 currency code. Must be USD, EUR, or GBP if collection_mode is manual.

originstring

Describes how this transaction was created.

subscription_idstring or null

Paddle ID of the subscription that this transaction is for, prefixed with sub_.

invoice_idstring or null

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_numberstring or null

Invoice number for this transaction. Automatically generated by Paddle when you mark a transaction as billed where collection_mode is manual.

collection_modestring

How payment is collected for this transaction. automatic for checkout, manual for invoices.

discount_idstring or null

Paddle ID of the discount applied to this transaction, prefixed with dsc_.

billing_detailsobject or null

Details for invoicing. Required if collection_mode is manual.

billing_periodobject or null

Time period that this transaction is for. Set automatically by Paddle for subscription renewals to describe the period that charges are for.

itemsarray[object]

List of items on this transaction. For calculated totals, use details.line_items.

detailsobject

Calculated totals for a transaction, including proration, discounts, tax, and currency conversion. Considered the source of truth for totals on a transaction.

paymentsarray[object]

List of payment attempts for this transaction, including successful payments. Sorted by created_at in descending order, so most recent attempts are returned first.

checkoutobject or null

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.

created_atstring<date-time>

RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.

updated_atstring<date-time>

RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.

billed_atstring<date-time> or null

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.

revised_atstring<date-time> or null

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.

addressobject

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.

adjustmentsarray[object]

Represents an adjustment entity.

adjustments_totalsobject

Object containing totals for all adjustments on a transaction. Returned when the include parameter is used with the adjustments_totals value.

businessobject

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.

customerobject

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.

discountobject

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.

available_payment_methodsarray[string]

List of available payment methods for this transaction. Returned when the include parameter is used with the available_payment_methods value.

metaobject

Information about this response.

request_idstring

Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.

paginationobject

Keys used for working with paginated results.

Response