PApaddlehq
Transactions

List transactions

Changed on

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.

get/transactions

Request

  • Base URL
    https://sandbox-api.paddle.com
  • Auth
    HTTP bearer

Query parameters

includeTransactionIncludeQuery[]

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

idstring[]

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

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_mode'automatic' | 'manual'

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

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_idstring[]

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

invoice_numberstring[]

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

originTransactionOriginQuery[]

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.

statusTransactionStatusQuery[]

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

subscription_idstring[] nullable

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

per_pageinteger

Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page in the response to see how many were returned.

Default: 30; Maximum: 30.

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.

Headers

Skip-Countstring

Set to true to skip the count query on list operations. When set, meta.pagination.estimated_total returns -1 instead of an exact count.

Response

The request has succeeded.

Changes

  • v1bbc0c72039c8Revision changes
    • info

      removed from the ////// response property oneOf list for the response status

  • v14f35a8c6ea4dRevision changes
    • breaking

      added to the //////// response property oneOf list for the response status

    • breaking

      added to the /////////// response property oneOf list for the response status

    • breaking

      added to the ///////// response property oneOf list for the response status

    • warning

      added the new blocked_by_policy enum value to the ///// response property for the response status

    • info

      response property data/items/payments/items/method_details/underlying_details/anyOf[subschema #1: PaymentMethodUnderlyingDetails]/korea_local/anyOf[subschema #1: Korean market underlying details]/ deprecated

    • info

      response property data/items/payments/items/method_details/underlying_details/anyOf[subschema #1: PaymentMethodUnderlyingDetails]/korea_local/anyOf[subschema #1: Korean market underlying details]/type deprecated

    • info

      response property data/items/payments/items/method_details/underlying_details/anyOf[subschema #1: PaymentMethodUnderlyingDetails]/korea_local/anyOf[subschema #1: Korean market underlying details]/type/allOf[subschema #1: Korean market underlying payment method type]/ deprecated