> For the complete documentation index, see [llms.txt](https://developer.paddle.com/llms.txt). # report.updated Occurs when a report is updated. --- Occurs when a report is updated. A report moves from `pending` to `ready` when Paddle has finished generating it and it's available to download. ## Schema ```json { "type": "object", "required": [ "event_id", "event_type", "occurred_at", "notification_id", "data" ], "properties": { "event_id": { "type": "string", "pattern": "^evt_[a-z\\d]{26}$", "description": "Unique Paddle ID for this event, prefixed with `evt_`.", "title": "Event ID", "examples": [ "evt_01gks14ge726w50ch2tmaw2a1x" ] }, "event_type": { "type": "string", "enum": [ "address.created", "address.imported", "address.updated", "adjustment.created", "adjustment.updated", "api_key.created", "api_key.expired", "api_key.expiring", "api_key.revoked", "api_key.updated", "api_key_exposure.created", "business.created", "business.imported", "business.updated", "client_token.created", "client_token.revoked", "client_token.updated", "customer.created", "customer.imported", "customer.updated", "discount.created", "discount.imported", "discount.updated", "discount_group.created", "discount_group.updated", "payment_method.saved", "payment_method.deleted", "payout.created", "payout.paid", "price.created", "price.imported", "price.updated", "product.created", "product.imported", "product.updated", "report.created", "report.updated", "subscription.activated", "subscription.canceled", "subscription.created", "subscription.imported", "subscription.past_due", "subscription.paused", "subscription.resumed", "subscription.trialing", "subscription.updated", "transaction.billed", "transaction.canceled", "transaction.completed", "transaction.created", "transaction.paid", "transaction.past_due", "transaction.payment_failed", "transaction.ready", "transaction.revised", "transaction.updated" ], "description": "Type of event sent by Paddle, in the format `entity.event_type`.", "title": "Event type name", "x-enum-descriptions": { "address.created": { "description": "An [`address.created`](https://developer.paddle.com/webhooks/addresses/address-created) event." }, "address.imported": { "description": "An [`address.imported`](https://developer.paddle.com/webhooks/addresses/address-imported) event." }, "address.updated": { "description": "An [`address.updated`](https://developer.paddle.com/webhooks/addresses/address-updated) event." }, "adjustment.created": { "description": "An [`adjustment.created`](https://developer.paddle.com/webhooks/adjustments/adjustment-created) event." }, "adjustment.updated": { "description": "An [`adjustment.updated`](https://developer.paddle.com/webhooks/adjustments/adjustment-updated) event." }, "api_key.created": { "description": "An [`api_key.created`](https://developer.paddle.com/webhooks/api-keys/api-key-created) event." }, "api_key.expired": { "description": "An [`api_key.expired`](https://developer.paddle.com/webhooks/api-keys/api-key-expired) event." }, "api_key.expiring": { "description": "An [`api_key.expiring`](https://developer.paddle.com/webhooks/api-keys/api-key-expiring) event." }, "api_key.revoked": { "description": "An [`api_key.revoked`](https://developer.paddle.com/webhooks/api-keys/api-key-revoked) event." }, "api_key.updated": { "description": "An [`api_key.updated`](https://developer.paddle.com/webhooks/api-keys/api-key-updated) event." }, "api_key_exposure.created": { "description": "An [`api_key_exposure.created`](https://developer.paddle.com/webhooks/api-key-exposures/api-key-exposure-created) event." }, "business.created": { "description": "A [`business.created`](https://developer.paddle.com/webhooks/businesses/business-created) event." }, "business.imported": { "description": "A [`business.imported`](https://developer.paddle.com/webhooks/businesses/business-imported) event." }, "business.updated": { "description": "A [`business.updated`](https://developer.paddle.com/webhooks/businesses/business-updated) event." }, "client_token.created": { "description": "A [`client_token.created`](https://developer.paddle.com/webhooks/client-tokens/client-token-created) event." }, "client_token.revoked": { "description": "A [`client_token.revoked`](https://developer.paddle.com/webhooks/client-tokens/client-token-revoked) event." }, "client_token.updated": { "description": "A [`client_token.updated`](https://developer.paddle.com/webhooks/client-tokens/client-token-updated) event." }, "customer.created": { "description": "A [`customer.created`](https://developer.paddle.com/webhooks/customers/customer-created) event." }, "customer.imported": { "description": "A [`customer.imported`](https://developer.paddle.com/webhooks/customers/customer-imported) event." }, "customer.updated": { "description": "A [`customer.updated`](https://developer.paddle.com/webhooks/customers/customer-updated) event." }, "discount.created": { "description": "A [`discount.created`](https://developer.paddle.com/webhooks/discounts/discount-created) event." }, "discount.imported": { "description": "A [`discount.imported`](https://developer.paddle.com/webhooks/discounts/discount-imported) event." }, "discount.updated": { "description": "A [`discount.updated`](https://developer.paddle.com/webhooks/discounts/discount-updated) event." }, "discount_group.created": { "description": "A [`discount_group.created`](https://developer.paddle.com/webhooks/discount-groups/discount-group-created) event." }, "discount_group.updated": { "description": "A [`discount_group.updated`](https://developer.paddle.com/webhooks/discount-groups/discount-group-updated) event." }, "payment_method.saved": { "description": "A [`payment_method.saved`](https://developer.paddle.com/webhooks/payment-methods/payment-method-saved) event." }, "payment_method.deleted": { "description": "A [`payment_method.deleted`](https://developer.paddle.com/webhooks/payment-methods/payment-method-deleted) event." }, "payout.created": { "description": "A [`payout.created`](https://developer.paddle.com/webhooks/payouts/payout-created) event." }, "payout.paid": { "description": "A [`payout.paid`](https://developer.paddle.com/webhooks/payouts/payout-paid) event." }, "price.created": { "description": "A [`price.created`](https://developer.paddle.com/webhooks/prices/price-created) event." }, "price.imported": { "description": "A [`price.imported`](https://developer.paddle.com/webhooks/prices/price-imported) event." }, "price.updated": { "description": "A [`price.updated`](https://developer.paddle.com/webhooks/prices/price-updated) event." }, "product.created": { "description": "A [`product.created`](https://developer.paddle.com/webhooks/products/product-created) event." }, "product.imported": { "description": "A [`product.imported`](https://developer.paddle.com/webhooks/products/product-imported) event." }, "product.updated": { "description": "A [`product.updated`](https://developer.paddle.com/webhooks/products/product-updated) event." }, "report.created": { "description": "A [`report.created`](https://developer.paddle.com/webhooks/reports/report-created) event." }, "report.updated": { "description": "A [`report.updated`](https://developer.paddle.com/webhooks/reports/report-updated) event." }, "subscription.activated": { "description": "A [`subscription.activated`](https://developer.paddle.com/webhooks/subscriptions/subscription-activated) event." }, "subscription.canceled": { "description": "A [`subscription.canceled`](https://developer.paddle.com/webhooks/subscriptions/subscription-canceled) event." }, "subscription.created": { "description": "A [`subscription.created`](https://developer.paddle.com/webhooks/subscriptions/subscription-created) event." }, "subscription.imported": { "description": "A [`subscription.imported`](https://developer.paddle.com/webhooks/subscriptions/subscription-imported) event." }, "subscription.past_due": { "description": "A [`subscription.past_due`](https://developer.paddle.com/webhooks/subscriptions/subscription-past-due) event." }, "subscription.paused": { "description": "A [`subscription.paused`](https://developer.paddle.com/webhooks/subscriptions/subscription-paused) event." }, "subscription.resumed": { "description": "A [`subscription.resumed`](https://developer.paddle.com/webhooks/subscriptions/subscription-resumed) event." }, "subscription.trialing": { "description": "A [`subscription.trialing`](https://developer.paddle.com/webhooks/subscriptions/subscription-trialing) event." }, "subscription.updated": { "description": "A [`subscription.updated`](https://developer.paddle.com/webhooks/subscriptions/subscription-updated) event." }, "transaction.billed": { "description": "A [`transaction.billed`](https://developer.paddle.com/webhooks/transactions/transaction-billed) event." }, "transaction.canceled": { "description": "A [`transaction.canceled`](https://developer.paddle.com/webhooks/transactions/transaction-canceled) event." }, "transaction.completed": { "description": "A [`transaction.completed`](https://developer.paddle.com/webhooks/transactions/transaction-completed) event." }, "transaction.created": { "description": "A [`transaction.created`](https://developer.paddle.com/webhooks/transactions/transaction-created) event." }, "transaction.paid": { "description": "A [`transaction.paid`](https://developer.paddle.com/webhooks/transactions/transaction-paid) event." }, "transaction.past_due": { "description": "A [`transaction.past_due`](https://developer.paddle.com/webhooks/transactions/transaction-past-due) event." }, "transaction.payment_failed": { "description": "A [`transaction.payment_failed`](https://developer.paddle.com/webhooks/transactions/transaction-payment-failed) event." }, "transaction.ready": { "description": "A [`transaction.ready`](https://developer.paddle.com/webhooks/transactions/transaction-ready) event." }, "transaction.revised": { "description": "A [`transaction.revised`](https://developer.paddle.com/webhooks/transactions/transaction-revised) event." }, "transaction.updated": { "description": "A [`transaction.updated`](https://developer.paddle.com/webhooks/transactions/transaction-updated) event." } } }, "occurred_at": { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string of when this event occurred.", "title": "Timestamp", "examples": [ "2024-10-12T07:20:50.52Z" ] }, "notification_id": { "type": "string", "pattern": "^ntf_[a-z\\d]{26}$", "description": "Unique Paddle ID for this notification, prefixed with `ntf_`.", "title": "Notification ID", "examples": [ "ntf_01ghbkd0frb9k95cnhwd1bxpvk" ] }, "data": { "oneOf": [ { "type": "object", "required": [ "id", "status", "rows", "expires_at", "updated_at", "created_at", "type", "filters" ], "properties": { "id": { "type": "string", "pattern": "^[a-z]{3,10}_[a-z\\d]{26}$", "description": "Unique Paddle ID for this report, prefixed with `rep_`", "title": "PaddleID", "examples": [ "txnitm_01gm302t81w94gyjpjpqypkzkf", "txn_01h04vsbhqc62t8hmd4z3b578c", "sub_01h04vsc0qhwtsbsxh3422wjs4", "rep_01h9apkx1d320kpvvfyezr96k0", "pro_01gsz97mq9pa4fkyy0wqenepkz", "pri_01gsz8z1q1n00f12qt82y31smh", "ntfset_01gt21c5pdx9q1e4mh1xrsjjn6", "ntflog_01gyfq570sy1nsv2123sbs68kv", "ntf_01ghbkd0frb9k95cnhwd1bxpvk", "evt_01gks14ge726w50ch2tmaw2a1x", "dsc_01gv5kpg05xp104ek2fmgjwttf", "ctm_01grnn4zta5a1mf02jjze7y2ys", "biz_01grrebrzaee2qj2fqqhmcyzaj", "adjitm_01gw4rs4kex0prncwfne87ft8x", "adj_01gya6twkp8y0tv1e19rsgst9m", "add_01gm302t81w94gyjpjpqypkzkf" ] }, "status": { "type": "string", "enum": [ "pending", "ready", "failed", "expired" ], "description": "Status of this report. Set automatically by Paddle.\n\nReports are created as `pending` initially, then move to `ready` when they're available to download.", "title": "ReportStatus", "x-enum-descriptions": { "pending": { "description": "Report created, but Paddle is processing it. It's not yet ready for download." }, "ready": { "description": "Report fully processed by Paddle and ready for download." }, "failed": { "description": "There was a problem processing this report." }, "expired": { "description": "Report has expired and is no longer accessible." } }, "default": "pending" }, "rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Number of records in this report. `null` if the report is `pending`." }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string.", "title": "Timestamp", "examples": [ "2024-10-12T07:20:50.52Z" ] }, { "type": "null" } ], "description": "RFC 3339 datetime string of when this report expires. The report is no longer available to download after this date." }, "updated_at": { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string of when this report was last updated.", "title": "Updated at", "examples": [ "2024-10-13T07:20:50.52Z" ] }, "created_at": { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string of when this report was created.", "title": "Created at", "examples": [ "2024-10-12T07:20:50.52Z" ] }, "type": { "type": "string", "enum": [ "adjustments", "adjustment_line_items" ], "description": "Type of report to create.", "title": "AdjustmentsReportType", "examples": [ "adjustments" ], "x-enum-descriptions": { "adjustments": { "description": "Adjustments reports contain information about refunds, credits, and chargebacks." }, "adjustment_line_items": { "description": "Adjustments reports contain information about refunds, credits, and chargebacks. The report is broken down by line item level." } } }, "filters": { "type": "array", "items": { "type": "object", "required": [ "name", "operator", "value" ], "properties": { "name": { "type": "string", "enum": [ "action", "currency_code", "status", "updated_at" ], "x-enum-descriptions": { "action": { "description": "Filter by adjustment action. Pass an array of strings containing any valid value for the `action` field against an adjustment." }, "currency_code": { "description": "Filter by transaction or adjustment currency. Pass an array of strings containing any valid supported three-letter ISO 4217 currency code." }, "status": { "description": "Filter by transaction or adjustment status. Pass an array of strings containing any valid value for the `status` field against a transaction or an adjustment." }, "updated_at": { "description": "Filter by transaction or adjustment updated date. Pass an RFC 3339 datetime string." } }, "description": "Field name to filter by.", "title": "AdjustmentsReportFilterName" }, "operator": { "anyOf": [ { "type": "string", "enum": [ "lt", "gte" ], "description": "Operator to use when filtering.", "title": "FilterOperator", "examples": [ "lt" ], "x-enum-descriptions": { "lt": { "description": "Less than." }, "gte": { "description": "Greater than or equal to." } } }, { "type": "null" } ], "description": "Operator to use when filtering. Valid when filtering by `updated_at`, `null` otherwise." }, "value": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "pending_approval", "approved", "rejected", "reversed" ], "description": "Status of this adjustment. Set automatically by Paddle.\n\nMost refunds for live accounts are created with the status of `pending_approval` until reviewed by Paddle, but some are automatically approved. For sandbox accounts, Paddle automatically approves refunds every ten minutes.\n\nCredit adjustments don't require approval from Paddle, so they're created as `approved`.", "x-enum-descriptions": { "pending_approval": { "description": "Adjustment is pending approval by Paddle. Most refunds for live accounts must be approved by Paddle." }, "approved": { "description": "Adjustment is approved. Default for credits. Set when Paddle approves a refund that was `pending_approval`." }, "rejected": { "description": "Adjustment has been rejected. Set when Paddle rejects a refund that was `pending_approval`." }, "reversed": { "description": "Adjustment has been reversed. Set by Paddle when a `chargeback_reversal` or `credit_reversal` adjustment is created for this adjustment." } } } }, { "type": "array", "items": { "type": "string", "enum": [ "credit", "refund", "chargeback", "chargeback_reverse", "chargeback_warning", "chargeback_warning_reverse", "credit_reverse" ], "description": "How this adjustment impacts the related transaction.", "title": "AdjustmentAction", "x-enum-descriptions": { "credit": { "description": "Credits some or all the related transaction." }, "refund": { "description": "Refunds some or all the related transaction. Must be approved by Paddle in most cases." }, "chargeback": { "description": "Chargeback for the related transaction. Automatically created by Paddle when a customer successfully disputes a charge." }, "chargeback_reverse": { "description": "Reversal of a chargeback for the related transaction. Automatically created by Paddle when Paddle contests a chargeback successfully." }, "chargeback_warning": { "description": "Warning of an upcoming chargeback for the related transaction. Automatically created by Paddle." }, "chargeback_warning_reverse": { "description": "Reversal of a chargeback warning for the related transaction. Automatically created by Paddle." }, "credit_reverse": { "description": "Reversal of a credit for the related transaction. Automatically created by Paddle." } } } }, { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string.", "title": "Timestamp", "examples": [ "2024-10-12T07:20:50.52Z" ] }, { "type": "string", "format": "date" }, { "type": "array", "items": { "type": "string" } }, { "type": "string" } ], "description": "Value to filter by. Check the allowed values descriptions for the `name` field to see valid values for a field." } }, "description": "Filter criteria for this report. If no `gte` filter for `updated_at` is passed when creating, reports are filtered to include data updated in the last month. This means `updated_at` is greater than or equal to (`gte`) the same date and time one calendar month before the report was generated, so the window is between 28 and 31 days depending on the month.", "title": "AdjustmentsReportFilters" }, "maxItems": 10, "description": "Filter criteria for this report. If no `gte` filter for `updated_at` is passed, reports are filtered to include data updated in the last month. This means `updated_at` is greater than or equal to (`gte`) the same date and time one calendar month before the report was generated, so the window is between 28 and 31 days depending on the month." } }, "description": "Report entity when working with adjustments reports.", "title": "ReportAdjustments" }, { "type": "object", "required": [ "id", "status", "rows", "expires_at", "updated_at", "created_at", "type", "filters" ], "properties": { "id": { "type": "string", "pattern": "^[a-z]{3,10}_[a-z\\d]{26}$", "description": "Unique Paddle ID for this report, prefixed with `rep_`", "title": "PaddleID", "examples": [ "txnitm_01gm302t81w94gyjpjpqypkzkf", "txn_01h04vsbhqc62t8hmd4z3b578c", "sub_01h04vsc0qhwtsbsxh3422wjs4", "rep_01h9apkx1d320kpvvfyezr96k0", "pro_01gsz97mq9pa4fkyy0wqenepkz", "pri_01gsz8z1q1n00f12qt82y31smh", "ntfset_01gt21c5pdx9q1e4mh1xrsjjn6", "ntflog_01gyfq570sy1nsv2123sbs68kv", "ntf_01ghbkd0frb9k95cnhwd1bxpvk", "evt_01gks14ge726w50ch2tmaw2a1x", "dsc_01gv5kpg05xp104ek2fmgjwttf", "ctm_01grnn4zta5a1mf02jjze7y2ys", "biz_01grrebrzaee2qj2fqqhmcyzaj", "adjitm_01gw4rs4kex0prncwfne87ft8x", "adj_01gya6twkp8y0tv1e19rsgst9m", "add_01gm302t81w94gyjpjpqypkzkf" ] }, "status": { "type": "string", "enum": [ "pending", "ready", "failed", "expired" ], "description": "Status of this report. Set automatically by Paddle.\n\nReports are created as `pending` initially, then move to `ready` when they're available to download.", "title": "ReportStatus", "x-enum-descriptions": { "pending": { "description": "Report created, but Paddle is processing it. It's not yet ready for download." }, "ready": { "description": "Report fully processed by Paddle and ready for download." }, "failed": { "description": "There was a problem processing this report." }, "expired": { "description": "Report has expired and is no longer accessible." } }, "default": "pending" }, "rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Number of records in this report. `null` if the report is `pending`." }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string.", "title": "Timestamp", "examples": [ "2024-10-12T07:20:50.52Z" ] }, { "type": "null" } ], "description": "RFC 3339 datetime string of when this report expires. The report is no longer available to download after this date." }, "updated_at": { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string of when this report was last updated.", "title": "Updated at", "examples": [ "2024-10-13T07:20:50.52Z" ] }, "created_at": { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string of when this report was created.", "title": "Created at", "examples": [ "2024-10-12T07:20:50.52Z" ] }, "type": { "type": "string", "enum": [ "transactions", "transaction_line_items" ], "description": "Type of report to create.", "title": "TransactionsReportType", "examples": [ "transactions" ], "x-enum-descriptions": { "transactions": { "description": "Transactions reports contain information about revenue received, past due invoices, draft and issued invoices, and canceled transactions." }, "transaction_line_items": { "description": "Transactions reports contain information about revenue received, past due invoices, draft and issued invoices, and canceled transactions. The report is broken down by line item level." } } }, "filters": { "type": "array", "items": { "type": "object", "required": [ "name", "operator", "value" ], "properties": { "name": { "type": "string", "enum": [ "collection_mode", "currency_code", "origin", "status", "updated_at" ], "description": "Field name to filter by.", "title": "TransactionsReportFilterName", "x-enum-descriptions": { "collection_mode": { "description": "Filter by collection mode. Pass an array of strings containing any valid value for the `collection_mode` field against a transaction." }, "currency_code": { "description": "Filter by transaction or adjustment currency. Pass an array of strings containing any valid supported three-letter ISO 4217 currency code." }, "origin": { "description": "Filter by transaction origin. Pass an array of strings containing any valid value for the origin field against a transaction." }, "status": { "description": "Filter by transaction or adjustment status. Pass an array of strings containing any valid value for the `status` field against a transaction or an adjustment." }, "updated_at": { "description": "Filter by transaction or adjustment updated date. Pass an RFC 3339 datetime string." } } }, "operator": { "anyOf": [ { "type": "string", "enum": [ "lt", "gte" ], "description": "Operator to use when filtering.", "title": "FilterOperator", "examples": [ "lt" ], "x-enum-descriptions": { "lt": { "description": "Less than." }, "gte": { "description": "Greater than or equal to." } } }, { "type": "null" } ], "description": "Operator to use when filtering. Valid when filtering by `updated_at`, `null` otherwise." }, "value": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ], "description": "Value to filter by. Check the allowed values descriptions for the `name` field to see valid values for a field." } }, "title": "TransactionsReportFilters" }, "maxItems": 10, "description": "Filter criteria for this report. If no `gte` filter for `updated_at` is passed, reports are filtered to include data updated in the last month. This means `updated_at` is greater than or equal to (`gte`) the same date and time one calendar month before the report was generated, so the window is between 28 and 31 days depending on the month." } }, "description": "Report entity when working with transactions reports.", "title": "ReportTransactions" }, { "type": "object", "required": [ "id", "status", "rows", "expires_at", "updated_at", "created_at", "type", "filters" ], "properties": { "id": { "type": "string", "pattern": "^[a-z]{3,10}_[a-z\\d]{26}$", "description": "Unique Paddle ID for this report, prefixed with `rep_`", "title": "PaddleID", "examples": [ "txnitm_01gm302t81w94gyjpjpqypkzkf", "txn_01h04vsbhqc62t8hmd4z3b578c", "sub_01h04vsc0qhwtsbsxh3422wjs4", "rep_01h9apkx1d320kpvvfyezr96k0", "pro_01gsz97mq9pa4fkyy0wqenepkz", "pri_01gsz8z1q1n00f12qt82y31smh", "ntfset_01gt21c5pdx9q1e4mh1xrsjjn6", "ntflog_01gyfq570sy1nsv2123sbs68kv", "ntf_01ghbkd0frb9k95cnhwd1bxpvk", "evt_01gks14ge726w50ch2tmaw2a1x", "dsc_01gv5kpg05xp104ek2fmgjwttf", "ctm_01grnn4zta5a1mf02jjze7y2ys", "biz_01grrebrzaee2qj2fqqhmcyzaj", "adjitm_01gw4rs4kex0prncwfne87ft8x", "adj_01gya6twkp8y0tv1e19rsgst9m", "add_01gm302t81w94gyjpjpqypkzkf" ] }, "status": { "type": "string", "enum": [ "pending", "ready", "failed", "expired" ], "description": "Status of this report. Set automatically by Paddle.\n\nReports are created as `pending` initially, then move to `ready` when they're available to download.", "title": "ReportStatus", "x-enum-descriptions": { "pending": { "description": "Report created, but Paddle is processing it. It's not yet ready for download." }, "ready": { "description": "Report fully processed by Paddle and ready for download." }, "failed": { "description": "There was a problem processing this report." }, "expired": { "description": "Report has expired and is no longer accessible." } }, "default": "pending" }, "rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Number of records in this report. `null` if the report is `pending`." }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string.", "title": "Timestamp", "examples": [ "2024-10-12T07:20:50.52Z" ] }, { "type": "null" } ], "description": "RFC 3339 datetime string of when this report expires. The report is no longer available to download after this date." }, "updated_at": { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string of when this report was last updated.", "title": "Updated at", "examples": [ "2024-10-13T07:20:50.52Z" ] }, "created_at": { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string of when this report was created.", "title": "Created at", "examples": [ "2024-10-12T07:20:50.52Z" ] }, "type": { "type": "string", "enum": [ "products_prices" ], "description": "Type of report to create.", "title": "ProductsPricesReportType", "examples": [ "products_prices" ], "x-enum-descriptions": { "products_prices": { "description": "Products and prices reports contain information about your products and prices. May include non-catalog products and prices." } } }, "filters": { "type": "array", "items": { "type": "object", "required": [ "name", "operator", "value" ], "properties": { "name": { "type": "string", "enum": [ "product_status", "price_status", "product_type", "price_type", "product_updated_at", "price_updated_at" ], "description": "Field name to filter by.", "title": "ProductPricesReportFilterName", "x-enum-descriptions": { "product_status": { "description": "Filter by product status. Pass an array of strings containing any valid value for the `status` field against a product." }, "price_status": { "description": "Filter by price status. Pass an array of strings containing any valid value for the `status` field against a price." }, "product_type": { "description": "Filter by product type. Pass an array of strings containing any valid value for the `type` field against a product." }, "price_type": { "description": "Filter by price type. Pass an array of strings containing any valid value for the `type` field against a price." }, "product_updated_at": { "description": "Filter by product `updated_at` date. Pass an RFC 3339 datetime string." }, "price_updated_at": { "description": "Filter by price `updated_at` date. Pass an RFC 3339 datetime string." } } }, "operator": { "anyOf": [ { "type": "string", "enum": [ "lt", "gte" ], "description": "Operator to use when filtering.", "title": "FilterOperator", "examples": [ "lt" ], "x-enum-descriptions": { "lt": { "description": "Less than." }, "gte": { "description": "Greater than or equal to." } } }, { "type": "null" } ], "description": "Operator to use when filtering. Valid when filtering by `updated_at`, `null` otherwise." }, "value": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ], "description": "Value to filter by." } }, "description": "List of filters applied to this report.", "title": "ProductPricesReportFilters" }, "maxItems": 10, "description": "Filter criteria for this report. `product_updated_at` and `price_updated_at` are defaulted independently: a field with no `gte` filter is filtered to include data updated in the last month, even when the other field has one. This means the field is set to greater than or equal to (`gte`) the same date and time one calendar month before the report was generated, so the window is between 28 and 31 days depending on the month." } }, "description": "Report entity when working with the products and prices report.", "title": "ReportProductsPrices" }, { "type": "object", "required": [ "id", "status", "rows", "expires_at", "updated_at", "created_at", "type", "filters" ], "properties": { "id": { "type": "string", "pattern": "^[a-z]{3,10}_[a-z\\d]{26}$", "description": "Unique Paddle ID for this report, prefixed with `rep_`", "title": "PaddleID", "examples": [ "txnitm_01gm302t81w94gyjpjpqypkzkf", "txn_01h04vsbhqc62t8hmd4z3b578c", "sub_01h04vsc0qhwtsbsxh3422wjs4", "rep_01h9apkx1d320kpvvfyezr96k0", "pro_01gsz97mq9pa4fkyy0wqenepkz", "pri_01gsz8z1q1n00f12qt82y31smh", "ntfset_01gt21c5pdx9q1e4mh1xrsjjn6", "ntflog_01gyfq570sy1nsv2123sbs68kv", "ntf_01ghbkd0frb9k95cnhwd1bxpvk", "evt_01gks14ge726w50ch2tmaw2a1x", "dsc_01gv5kpg05xp104ek2fmgjwttf", "ctm_01grnn4zta5a1mf02jjze7y2ys", "biz_01grrebrzaee2qj2fqqhmcyzaj", "adjitm_01gw4rs4kex0prncwfne87ft8x", "adj_01gya6twkp8y0tv1e19rsgst9m", "add_01gm302t81w94gyjpjpqypkzkf" ] }, "status": { "type": "string", "enum": [ "pending", "ready", "failed", "expired" ], "description": "Status of this report. Set automatically by Paddle.\n\nReports are created as `pending` initially, then move to `ready` when they're available to download.", "title": "ReportStatus", "x-enum-descriptions": { "pending": { "description": "Report created, but Paddle is processing it. It's not yet ready for download." }, "ready": { "description": "Report fully processed by Paddle and ready for download." }, "failed": { "description": "There was a problem processing this report." }, "expired": { "description": "Report has expired and is no longer accessible." } }, "default": "pending" }, "rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Number of records in this report. `null` if the report is `pending`." }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string.", "title": "Timestamp", "examples": [ "2024-10-12T07:20:50.52Z" ] }, { "type": "null" } ], "description": "RFC 3339 datetime string of when this report expires. The report is no longer available to download after this date." }, "updated_at": { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string of when this report was last updated.", "title": "Updated at", "examples": [ "2024-10-13T07:20:50.52Z" ] }, "created_at": { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string of when this report was created.", "title": "Created at", "examples": [ "2024-10-12T07:20:50.52Z" ] }, "type": { "type": "string", "enum": [ "discounts" ], "description": "Type of report to create.", "title": "DiscountsReportType", "examples": [ "discounts" ], "x-enum-descriptions": { "discounts": { "description": "Discounts reports contain information about your product and checkout discounts." } } }, "filters": { "type": "array", "items": { "type": "object", "required": [ "name", "operator", "value" ], "properties": { "name": { "type": "string", "enum": [ "type", "status", "updated_at" ], "description": "Field name to filter by.", "title": "DiscountsReportFilterName", "x-enum-descriptions": { "type": { "description": "Filter by discount type. Pass an array of strings containing any valid value for the `type` field against a discount." }, "status": { "description": "Filter by discount status. Pass an array of strings containing any valid value for the `status` field against a discount." }, "updated_at": { "description": "Filter by discount updated date. Pass an RFC 3339 datetime string." } } }, "operator": { "anyOf": [ { "type": "string", "enum": [ "lt", "gte" ], "description": "Operator to use when filtering.", "title": "FilterOperator", "examples": [ "lt" ], "x-enum-descriptions": { "lt": { "description": "Less than." }, "gte": { "description": "Greater than or equal to." } } }, { "type": "null" } ], "description": "Operator to use when filtering. Valid when filtering by `updated_at`, `null` otherwise." }, "value": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ], "description": "Value to filter by. Check the allowed values descriptions for the `name` field to see valid values for a field." } }, "description": "List of filters applied to this report.", "title": "DiscountsReportFilters" }, "maxItems": 10, "description": "Filter criteria for this report. If no `gte` filter for `updated_at` is passed, reports are filtered to include data updated in the last month. This means `updated_at` is greater than or equal to (`gte`) the same date and time one calendar month before the report was generated, so the window is between 28 and 31 days depending on the month." } }, "description": "Report entity when working with the discounts report.", "title": "ReportDiscounts" }, { "type": "object", "required": [ "id", "status", "rows", "expires_at", "updated_at", "created_at", "type", "filters" ], "properties": { "id": { "type": "string", "pattern": "^[a-z]{3,10}_[a-z\\d]{26}$", "description": "Unique Paddle ID for this report, prefixed with `rep_`", "title": "PaddleID", "examples": [ "txnitm_01gm302t81w94gyjpjpqypkzkf", "txn_01h04vsbhqc62t8hmd4z3b578c", "sub_01h04vsc0qhwtsbsxh3422wjs4", "rep_01h9apkx1d320kpvvfyezr96k0", "pro_01gsz97mq9pa4fkyy0wqenepkz", "pri_01gsz8z1q1n00f12qt82y31smh", "ntfset_01gt21c5pdx9q1e4mh1xrsjjn6", "ntflog_01gyfq570sy1nsv2123sbs68kv", "ntf_01ghbkd0frb9k95cnhwd1bxpvk", "evt_01gks14ge726w50ch2tmaw2a1x", "dsc_01gv5kpg05xp104ek2fmgjwttf", "ctm_01grnn4zta5a1mf02jjze7y2ys", "biz_01grrebrzaee2qj2fqqhmcyzaj", "adjitm_01gw4rs4kex0prncwfne87ft8x", "adj_01gya6twkp8y0tv1e19rsgst9m", "add_01gm302t81w94gyjpjpqypkzkf" ] }, "status": { "type": "string", "enum": [ "pending", "ready", "failed", "expired" ], "description": "Status of this report. Set automatically by Paddle.\n\nReports are created as `pending` initially, then move to `ready` when they're available to download.", "title": "ReportStatus", "x-enum-descriptions": { "pending": { "description": "Report created, but Paddle is processing it. It's not yet ready for download." }, "ready": { "description": "Report fully processed by Paddle and ready for download." }, "failed": { "description": "There was a problem processing this report." }, "expired": { "description": "Report has expired and is no longer accessible." } }, "default": "pending" }, "rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Number of records in this report. `null` if the report is `pending`." }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string.", "title": "Timestamp", "examples": [ "2024-10-12T07:20:50.52Z" ] }, { "type": "null" } ], "description": "RFC 3339 datetime string of when this report expires. The report is no longer available to download after this date." }, "updated_at": { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string of when this report was last updated.", "title": "Updated at", "examples": [ "2024-10-13T07:20:50.52Z" ] }, "created_at": { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string of when this report was created.", "title": "Created at", "examples": [ "2024-10-12T07:20:50.52Z" ] }, "type": { "type": "string", "enum": [ "balance" ], "description": "Type of report to create.", "title": "BalanceReportType", "deprecated": true, "examples": [ "balance" ], "x-enum-descriptions": { "balance": { "description": "Balance reports contain information about your account balance activity, including all movements of funds in and out of your balance. Deprecated.", "deprecated": true } } }, "filters": { "type": "array", "items": { "type": "object", "required": [ "name", "operator", "value" ], "properties": { "name": { "type": "string", "enum": [ "updated_at" ], "description": "Field name to filter by.", "title": "BalanceReportFilterName", "x-enum-descriptions": { "updated_at": { "description": "Filter by balance change updated date. Pass an RFC 3339 datetime string." } } }, "operator": { "anyOf": [ { "type": "string", "enum": [ "lt", "gte" ], "description": "Operator to use when filtering.", "title": "FilterOperator", "examples": [ "lt" ], "x-enum-descriptions": { "lt": { "description": "Less than." }, "gte": { "description": "Greater than or equal to." } } }, { "type": "null" } ], "description": "Operator to use when filtering. Valid when filtering by `updated_at`, `null` otherwise." }, "value": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ], "description": "Value to filter by. Check the allowed values descriptions for the `name` field to see valid values for a field." } }, "description": "List of filters applied to this report.", "title": "BalanceReportFilters" }, "maxItems": 10, "description": "Filter criteria for this report. If no `gte` filter for `updated_at` is passed, reports are filtered to include data updated in the last month. This means `updated_at` is greater than or equal to (`gte`) the same date and time one calendar month before the report was generated, so the window is between 28 and 31 days depending on the month." } }, "description": "Report entity when working with the balance report. Deprecated.", "title": "ReportBalance", "deprecated": true }, { "type": "object", "required": [ "id", "status", "rows", "expires_at", "updated_at", "created_at", "type", "filters" ], "properties": { "id": { "type": "string", "pattern": "^[a-z]{3,10}_[a-z\\d]{26}$", "description": "Unique Paddle ID for this report, prefixed with `rep_`", "title": "PaddleID", "examples": [ "txnitm_01gm302t81w94gyjpjpqypkzkf", "txn_01h04vsbhqc62t8hmd4z3b578c", "sub_01h04vsc0qhwtsbsxh3422wjs4", "rep_01h9apkx1d320kpvvfyezr96k0", "pro_01gsz97mq9pa4fkyy0wqenepkz", "pri_01gsz8z1q1n00f12qt82y31smh", "ntfset_01gt21c5pdx9q1e4mh1xrsjjn6", "ntflog_01gyfq570sy1nsv2123sbs68kv", "ntf_01ghbkd0frb9k95cnhwd1bxpvk", "evt_01gks14ge726w50ch2tmaw2a1x", "dsc_01gv5kpg05xp104ek2fmgjwttf", "ctm_01grnn4zta5a1mf02jjze7y2ys", "biz_01grrebrzaee2qj2fqqhmcyzaj", "adjitm_01gw4rs4kex0prncwfne87ft8x", "adj_01gya6twkp8y0tv1e19rsgst9m", "add_01gm302t81w94gyjpjpqypkzkf" ] }, "status": { "type": "string", "enum": [ "pending", "ready", "failed", "expired" ], "description": "Status of this report. Set automatically by Paddle.\n\nReports are created as `pending` initially, then move to `ready` when they're available to download.", "title": "ReportStatus", "x-enum-descriptions": { "pending": { "description": "Report created, but Paddle is processing it. It's not yet ready for download." }, "ready": { "description": "Report fully processed by Paddle and ready for download." }, "failed": { "description": "There was a problem processing this report." }, "expired": { "description": "Report has expired and is no longer accessible." } }, "default": "pending" }, "rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Number of records in this report. `null` if the report is `pending`." }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string.", "title": "Timestamp", "examples": [ "2024-10-12T07:20:50.52Z" ] }, { "type": "null" } ], "description": "RFC 3339 datetime string of when this report expires. The report is no longer available to download after this date." }, "updated_at": { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string of when this report was last updated.", "title": "Updated at", "examples": [ "2024-10-13T07:20:50.52Z" ] }, "created_at": { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string of when this report was created.", "title": "Created at", "examples": [ "2024-10-12T07:20:50.52Z" ] }, "type": { "type": "string", "enum": [ "payout_reconciliation" ], "description": "Type of report to create.", "title": "PayoutReconciliationReportType", "examples": [ "payout_reconciliation" ], "x-enum-descriptions": { "payout_reconciliation": { "description": "Payout reconciliation reports contain information about your payout activity, including all transactions and adjustments that make up specific payouts." } } }, "filters": { "type": "array", "items": { "type": "object", "required": [ "name", "operator", "value" ], "properties": { "name": { "type": "string", "enum": [ "remittance_reference", "transaction_updated_at", "balance_movement_date", "balance_movement_type" ], "description": "Field name to filter by.", "title": "ReconciliationReportFilterName", "x-enum-descriptions": { "remittance_reference": { "description": "Filter by remittance reference. Pass an array with one string containing a remittance reference." }, "transaction_updated_at": { "description": "Filter by transaction updated date. Pass an RFC 3339 datetime string." }, "balance_movement_date": { "description": "Filter by the date the balance movement occurred. Pass an RFC 3339 datetime string." }, "balance_movement_type": { "description": "Filter by balance movement type. Pass one or more values from the `BalanceMovementType` enum." } } }, "operator": { "anyOf": [ { "type": "string", "enum": [ "lt", "gte" ], "description": "Operator to use when filtering.", "title": "FilterOperator", "examples": [ "lt" ], "x-enum-descriptions": { "lt": { "description": "Less than." }, "gte": { "description": "Greater than or equal to." } } }, { "type": "null" } ], "description": "Operator to use when filtering. Valid when filtering by `transaction_updated_at` or `balance_movement_date`, must be `null` otherwise." }, "value": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" }, { "type": "array", "items": { "type": "string", "enum": [ "rebate", "swift_fee", "sale", "refund", "chargeback_warning", "chargeback_warning_reverse", "chargeback", "chargeback_reverse", "credit" ], "description": "Type of balance movement to filter by.", "title": "BalanceMovementType", "x-enum-descriptions": { "rebate": { "description": "A manual adjustment to your balance that isn't tied to a specific transaction." }, "swift_fee": { "description": "A SWIFT or wire-transfer fee deducted when your payout is made. It isn't tied to a specific transaction." }, "sale": { "description": "Your earnings from a paid transaction. This is the most common balance movement." }, "refund": { "description": "Refunds some or all the related transaction. Must be approved by Paddle in most cases." }, "chargeback_warning": { "description": "Warning of an upcoming chargeback for the related transaction. Automatically created by Paddle." }, "chargeback_warning_reverse": { "description": "Reversal of a chargeback warning for the related transaction. Automatically created by Paddle." }, "chargeback": { "description": "Chargeback for the related transaction. Automatically created by Paddle when a customer successfully disputes a charge." }, "chargeback_reverse": { "description": "Reversal of a chargeback for the related transaction. Automatically created by Paddle when Paddle contests a chargeback successfully." }, "credit": { "description": "Credits some or all the related transaction." } } } } ], "description": "Value to filter by. Check the allowed values descriptions for the `name` field to see valid values for a field." } }, "description": "List of filters applied to this report." }, "maxItems": 10, "description": "Filter criteria for this report. If none of a `gte` filter for `transaction_updated_at`, a `remittance_reference` filter, or a `balance_movement_date` filter is passed, reports are filtered to include data updated in the last month. This means `transaction_updated_at` is greater than or equal to (`gte`) the same date and time one calendar month before the report was generated, so the window is between 28 and 31 days depending on the month." } }, "description": "Report entity when working with payout reconciliation reports.", "title": "ReportPayoutReconciliation" }, { "type": "object", "required": [ "id", "status", "rows", "expires_at", "updated_at", "created_at", "type", "filters" ], "properties": { "id": { "type": "string", "pattern": "^[a-z]{3,10}_[a-z\\d]{26}$", "description": "Unique Paddle ID for this report, prefixed with `rep_`", "title": "PaddleID", "examples": [ "txnitm_01gm302t81w94gyjpjpqypkzkf", "txn_01h04vsbhqc62t8hmd4z3b578c", "sub_01h04vsc0qhwtsbsxh3422wjs4", "rep_01h9apkx1d320kpvvfyezr96k0", "pro_01gsz97mq9pa4fkyy0wqenepkz", "pri_01gsz8z1q1n00f12qt82y31smh", "ntfset_01gt21c5pdx9q1e4mh1xrsjjn6", "ntflog_01gyfq570sy1nsv2123sbs68kv", "ntf_01ghbkd0frb9k95cnhwd1bxpvk", "evt_01gks14ge726w50ch2tmaw2a1x", "dsc_01gv5kpg05xp104ek2fmgjwttf", "ctm_01grnn4zta5a1mf02jjze7y2ys", "biz_01grrebrzaee2qj2fqqhmcyzaj", "adjitm_01gw4rs4kex0prncwfne87ft8x", "adj_01gya6twkp8y0tv1e19rsgst9m", "add_01gm302t81w94gyjpjpqypkzkf" ] }, "status": { "type": "string", "enum": [ "pending", "ready", "failed", "expired" ], "description": "Status of this report. Set automatically by Paddle.\n\nReports are created as `pending` initially, then move to `ready` when they're available to download.", "title": "ReportStatus", "x-enum-descriptions": { "pending": { "description": "Report created, but Paddle is processing it. It's not yet ready for download." }, "ready": { "description": "Report fully processed by Paddle and ready for download." }, "failed": { "description": "There was a problem processing this report." }, "expired": { "description": "Report has expired and is no longer accessible." } }, "default": "pending" }, "rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Number of records in this report. `null` if the report is `pending`." }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string.", "title": "Timestamp", "examples": [ "2024-10-12T07:20:50.52Z" ] }, { "type": "null" } ], "description": "RFC 3339 datetime string of when this report expires. The report is no longer available to download after this date." }, "updated_at": { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string of when this report was last updated.", "title": "Updated at", "examples": [ "2024-10-13T07:20:50.52Z" ] }, "created_at": { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string of when this report was created.", "title": "Created at", "examples": [ "2024-10-12T07:20:50.52Z" ] }, "type": { "type": "string", "enum": [ "checkouts" ], "description": "Type of report to create.", "title": "CheckoutsReportType", "examples": [ "checkouts" ], "x-enum-descriptions": { "checkouts": { "description": "Checkouts reports contain information about your checkouts, including conversion and recovery data for each checkout session." } } }, "filters": { "type": "array", "items": { "type": "object", "required": [ "name", "operator", "value" ], "properties": { "name": { "type": "string", "enum": [ "checkout_created_at", "customer_country_code" ], "description": "Field name to filter by.", "title": "CheckoutsReportFilterName", "x-enum-descriptions": { "checkout_created_at": { "description": "Filter by checkout creation date. Pass an RFC 3339 datetime string. Combine two `checkout_created_at` filters with `gte` and `lt` operators to scope reports to a specific date range." }, "customer_country_code": { "description": "Filter by customer country. Pass an array of strings containing any valid two-letter ISO 3166-1 alpha-2 country code." } } }, "operator": { "anyOf": [ { "type": "string", "enum": [ "lt", "gte" ], "description": "Operator to use when filtering.", "title": "FilterOperator", "examples": [ "lt" ], "x-enum-descriptions": { "lt": { "description": "Less than." }, "gte": { "description": "Greater than or equal to." } } }, { "type": "null" } ], "description": "Operator to use when filtering. Valid when filtering by `checkout_created_at` (must be `gte` or `lt`), `null` otherwise." }, "value": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ], "description": "Value to filter by. Check the allowed values descriptions for the `name` field to see valid values for a field." } }, "description": "List of filters applied to this report." }, "maxItems": 10, "description": "Filter criteria for this report. If no `gte` filter for `checkout_created_at` is passed, reports are filtered to include checkouts created in the last month. This means `checkout_created_at` is greater than or equal to (`gte`) the same date and time one calendar month before the report was generated, so the window is between 28 and 31 days depending on the month. To filter by a specific date range, pass two `checkout_created_at` filters with `gte` and `lt` operators." } }, "description": "Report entity when working with checkouts reports.", "title": "ReportCheckouts" }, { "type": "object", "required": [ "id", "status", "rows", "expires_at", "updated_at", "created_at", "type", "filters" ], "properties": { "id": { "type": "string", "pattern": "^[a-z]{3,10}_[a-z\\d]{26}$", "description": "Unique Paddle ID for this report, prefixed with `rep_`", "title": "PaddleID", "examples": [ "txnitm_01gm302t81w94gyjpjpqypkzkf", "txn_01h04vsbhqc62t8hmd4z3b578c", "sub_01h04vsc0qhwtsbsxh3422wjs4", "rep_01h9apkx1d320kpvvfyezr96k0", "pro_01gsz97mq9pa4fkyy0wqenepkz", "pri_01gsz8z1q1n00f12qt82y31smh", "ntfset_01gt21c5pdx9q1e4mh1xrsjjn6", "ntflog_01gyfq570sy1nsv2123sbs68kv", "ntf_01ghbkd0frb9k95cnhwd1bxpvk", "evt_01gks14ge726w50ch2tmaw2a1x", "dsc_01gv5kpg05xp104ek2fmgjwttf", "ctm_01grnn4zta5a1mf02jjze7y2ys", "biz_01grrebrzaee2qj2fqqhmcyzaj", "adjitm_01gw4rs4kex0prncwfne87ft8x", "adj_01gya6twkp8y0tv1e19rsgst9m", "add_01gm302t81w94gyjpjpqypkzkf" ] }, "status": { "type": "string", "enum": [ "pending", "ready", "failed", "expired" ], "description": "Status of this report. Set automatically by Paddle.\n\nReports are created as `pending` initially, then move to `ready` when they're available to download.", "title": "ReportStatus", "x-enum-descriptions": { "pending": { "description": "Report created, but Paddle is processing it. It's not yet ready for download." }, "ready": { "description": "Report fully processed by Paddle and ready for download." }, "failed": { "description": "There was a problem processing this report." }, "expired": { "description": "Report has expired and is no longer accessible." } }, "default": "pending" }, "rows": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Number of records in this report. `null` if the report is `pending`." }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string.", "title": "Timestamp", "examples": [ "2024-10-12T07:20:50.52Z" ] }, { "type": "null" } ], "description": "RFC 3339 datetime string of when this report expires. The report is no longer available to download after this date." }, "updated_at": { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string of when this report was last updated.", "title": "Updated at", "examples": [ "2024-10-13T07:20:50.52Z" ] }, "created_at": { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string of when this report was created.", "title": "Created at", "examples": [ "2024-10-12T07:20:50.52Z" ] }, "type": { "type": "string", "enum": [ "subscriptions" ], "description": "Type of report to create.", "title": "SubscriptionsReportType", "examples": [ "subscriptions" ], "x-enum-descriptions": { "subscriptions": { "description": "Subscriptions reports contain information about your subscriptions, including status, items, billing cycle, billing dates, and customer location. Reports contain the current state of each subscription." } } }, "filters": { "type": "array", "items": { "type": "object", "required": [ "name", "operator", "value" ], "properties": { "name": { "type": "string", "enum": [ "subscription_status", "subscription_created_at", "customer_country_code", "subscription_scheduled_change_action" ], "description": "Field name to filter by.", "title": "SubscriptionsReportFilterName", "x-enum-descriptions": { "subscription_status": { "description": "Filter by subscription status. Pass one or more values from the `SubscriptionStatusFilter` enum." }, "subscription_created_at": { "description": "Filter by subscription creation date. Pass an RFC 3339 datetime string. Combine two `subscription_created_at` filters with `gte` and `lt` operators to scope reports to a specific date range." }, "customer_country_code": { "description": "Filter by customer country. Pass an array of strings containing any valid two-letter ISO 3166-1 alpha-2 country code." }, "subscription_scheduled_change_action": { "description": "Filter by the change scheduled on a subscription. Pass one or more values from the `SubscriptionScheduledChangeActionFilter` enum." } } }, "operator": { "anyOf": [ { "type": "string", "enum": [ "lt", "gte" ], "description": "Operator to use when filtering.", "title": "FilterOperator", "examples": [ "lt" ], "x-enum-descriptions": { "lt": { "description": "Less than." }, "gte": { "description": "Greater than or equal to." } } }, { "type": "null" } ], "description": "Operator to use when filtering. Valid when filtering by `subscription_created_at` (must be `gte` or `lt`), `null` otherwise." }, "value": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" }, { "type": "array", "items": { "type": "string", "enum": [ "active", "canceled", "past_due", "paused", "trialing" ], "description": "Subscription status to filter by.", "title": "SubscriptionStatusFilter", "x-enum-descriptions": { "active": { "description": "Include subscriptions that Paddle is billing for and that aren't past due." }, "canceled": { "description": "Include subscriptions that are canceled." }, "past_due": { "description": "Include subscriptions that have an overdue payment." }, "paused": { "description": "Include subscriptions that are paused." }, "trialing": { "description": "Include subscriptions that are in trial." } } } }, { "type": "array", "items": { "type": "string", "enum": [ "cancel", "pause", "resume", "none" ], "description": "Scheduled change action to filter by.", "title": "SubscriptionScheduledChangeActionFilter", "x-enum-descriptions": { "cancel": { "description": "Include subscriptions with a scheduled change to cancel." }, "pause": { "description": "Include subscriptions with a scheduled change to pause." }, "resume": { "description": "Include subscriptions with a scheduled change to resume. Only applies to paused subscriptions." }, "none": { "description": "Include subscriptions that don't have a scheduled change." } } } } ], "description": "Value to filter by. Check the allowed values descriptions for the `name` field to see valid values for a field." } }, "description": "List of filters applied to this report.", "title": "SubscriptionsReportFilters" }, "maxItems": 10, "description": "Filter criteria for this report. Subscriptions reports have no default date range. If you don't pass a `subscription_created_at` filter, reports include all your subscriptions. To filter by a specific date range, pass two `subscription_created_at` filters with `gte` and `lt` operators." } }, "description": "Report entity when working with subscriptions reports.", "title": "ReportSubscriptions" } ], "description": "New or changed entity." } } } ``` ## Example ```json { "event_id": "evt_01hvgdpmap3espxga4jwzb0agp", "event_type": "report.updated", "occurred_at": "2024-04-15T08:24:13.398892Z", "notification_id": "ntf_01hvgdpmd2g0dv4vpmys3z7bc3", "data": { "id": "rep_01hvgdpayq6kjzyk4hz5m02cpn", "rows": 8, "type": "adjustments", "status": "ready", "filters": [ { "name": "updated_at", "value": "2024-04-15", "operator": "lt" }, { "name": "updated_at", "value": "2024-01-01", "operator": "gte" }, { "name": "status", "value": [ "pending_approval", "approved" ], "operator": null }, { "name": "action", "value": [ "refund", "chargeback" ], "operator": null } ], "created_at": "2024-04-15T08:24:03.799Z", "expires_at": "2024-04-29T08:24:13.042686Z", "updated_at": "2024-04-15T08:24:13.042692Z" } } ```