Docs

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.

event_idstringrequired
Example: evt_01gks14ge726w50ch2tmaw2a1x
Unique Paddle ID for this event, prefixed with evt_.
Pattern: ^evt_[a-z\d]{26}$
event_typestringrequired
Type of event sent by Paddle, in the format entity.event_type.
Values
+ Show all values
occurred_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this event occurred.
notification_idstringrequired
Example: ntf_01ghbkd0frb9k95cnhwd1bxpvk
Unique Paddle ID for this notification, prefixed with ntf_.
Pattern: ^ntf_[a-z\d]{26}$
datarequired
New or changed entity.
ReportAdjustments
Report entity when working with adjustments reports.
idstringrequired
Example: txnitm_01gm302t81w94gyjpjpqypkzkf
Unique Paddle ID for this report, prefixed with rep_
Pattern: ^[a-z]{3,10}_[a-z\d]{26}$
statusstringrequired
Default: pending

Status of this report. Set automatically by Paddle.

Reports are created as pending initially, then move to ready when they're available to download.

Values
  • pending
    Report created, but Paddle is processing it. It's not yet ready for download.
  • ready
    Report fully processed by Paddle and ready for download.
  • failed
    There was a problem processing this report.
  • expired
    Report has expired and is no longer accessible.
rowsinteger | nullrequired
Number of records in this report. null if the report is pending.
expires_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string.
updated_atstring (date-time)required
Example: 2024-10-13T07:20:50.52Z
RFC 3339 datetime string of when this report was last updated.
created_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this report was created.
typestringrequired
Example: adjustments
Type of report to create.
Values
  • adjustments
    Adjustments reports contain information about refunds, credits, and chargebacks.
  • adjustment_line_items
    Adjustments reports contain information about refunds, credits, and chargebacks. The report is broken down by line item level.
filtersarrayrequired
Filter criteria for this report. If omitted, reports are filtered to include data updated in the last 30 days. This means updated_at is greater than or equal to (gte) the date 30 days ago from the time the report was generated.
Items: max 10
namestringrequired
Field name to filter by.
Values
  • action
    Filter by adjustment action. Pass an array of strings containing any valid value for the action field against an adjustment.
  • currency_code
    Filter by transaction or adjustment currency. Pass an array of strings containing any valid supported three-letter ISO 4217 currency code.
  • status
    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
    Filter by transaction or adjustment updated date. Pass an RFC 3339 datetime string.
operatorstring | nullrequired
Example: lt
Operator to use when filtering.
Values
  • lt
    Less than.
  • gte
    Greater than or equal to.
valuerequired
Value to filter by. Check the allowed values descriptions for the name field to see valid values for a field.
Array of string
Array of AdjustmentAction
Timestamp
RFC 3339 datetime string.
string (date)
ReportTransactions
Report entity when working with transactions reports.
idstringrequired
Example: txnitm_01gm302t81w94gyjpjpqypkzkf
Unique Paddle ID for this report, prefixed with rep_
Pattern: ^[a-z]{3,10}_[a-z\d]{26}$
statusstringrequired
Default: pending

Status of this report. Set automatically by Paddle.

Reports are created as pending initially, then move to ready when they're available to download.

Values
  • pending
    Report created, but Paddle is processing it. It's not yet ready for download.
  • ready
    Report fully processed by Paddle and ready for download.
  • failed
    There was a problem processing this report.
  • expired
    Report has expired and is no longer accessible.
rowsinteger | nullrequired
Number of records in this report. null if the report is pending.
expires_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string.
updated_atstring (date-time)required
Example: 2024-10-13T07:20:50.52Z
RFC 3339 datetime string of when this report was last updated.
created_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this report was created.
typestringrequired
Example: transactions
Type of report to create.
Values
  • transactions
    Transactions reports contain information about revenue received, past due invoices, draft and issued invoices, and canceled transactions.
  • transaction_line_items
    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.
filtersarrayrequired
Filter criteria for this report. If omitted, reports are filtered to include data updated in the last 30 days. This means updated_at is greater than or equal to (gte) the date 30 days ago from the time the report was generated.
Items: max 10
namestringrequired
Field name to filter by.
Values
  • collection_mode
    Filter by collection mode. Pass an array of strings containing any valid value for the collection_mode field against a transaction.
  • currency_code
    Filter by transaction or adjustment currency. Pass an array of strings containing any valid supported three-letter ISO 4217 currency code.
  • origin
    Filter by transaction origin. Pass an array of strings containing any valid value for the origin field against a transaction.
  • status
    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
    Filter by transaction or adjustment updated date. Pass an RFC 3339 datetime string.
operatorstring | nullrequired
Example: lt
Operator to use when filtering.
Values
  • lt
    Less than.
  • gte
    Greater than or equal to.
valuerequired
Value to filter by. Check the allowed values descriptions for the name field to see valid values for a field.
Array of string
string
ReportProductsPrices
Report entity when working with the products and prices report.
idstringrequired
Example: txnitm_01gm302t81w94gyjpjpqypkzkf
Unique Paddle ID for this report, prefixed with rep_
Pattern: ^[a-z]{3,10}_[a-z\d]{26}$
statusstringrequired
Default: pending

Status of this report. Set automatically by Paddle.

Reports are created as pending initially, then move to ready when they're available to download.

Values
  • pending
    Report created, but Paddle is processing it. It's not yet ready for download.
  • ready
    Report fully processed by Paddle and ready for download.
  • failed
    There was a problem processing this report.
  • expired
    Report has expired and is no longer accessible.
rowsinteger | nullrequired
Number of records in this report. null if the report is pending.
expires_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string.
updated_atstring (date-time)required
Example: 2024-10-13T07:20:50.52Z
RFC 3339 datetime string of when this report was last updated.
created_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this report was created.
typestringrequired
Example: products_prices
Type of report to create.
Values
  • products_prices
    Products and prices reports contain information about your products and prices. May include non-catalog products and prices.
filtersarrayrequired
Filter criteria for this report. If omitted, reports are filtered to include data updated in the last 30 days. This means product_updated_at and price_updated_at are greater than or equal to (gte) the date 30 days ago from the time the report was generated.
Items: max 10
namestringrequired
Field name to filter by.
Values
  • product_status
    Filter by product status. Pass an array of strings containing any valid value for the status field against a product.
  • price_status
    Filter by price status. Pass an array of strings containing any valid value for the status field against a price.
  • product_type
    Filter by product type. Pass an array of strings containing any valid value for the type field against a product.
  • price_type
    Filter by price type. Pass an array of strings containing any valid value for the type field against a price.
  • product_updated_at
    Filter by product updated_at date. Pass an RFC 3339 datetime string.
+ Show all values
  • price_updated_at
    Filter by price updated_at date. Pass an RFC 3339 datetime string.
operatorstring | nullrequired
Example: lt
Operator to use when filtering.
Values
  • lt
    Less than.
  • gte
    Greater than or equal to.
valuerequired
Value to filter by.
Array of string
string
ReportDiscounts
Report entity when working with the discounts report.
idstringrequired
Example: txnitm_01gm302t81w94gyjpjpqypkzkf
Unique Paddle ID for this report, prefixed with rep_
Pattern: ^[a-z]{3,10}_[a-z\d]{26}$
statusstringrequired
Default: pending

Status of this report. Set automatically by Paddle.

Reports are created as pending initially, then move to ready when they're available to download.

Values
  • pending
    Report created, but Paddle is processing it. It's not yet ready for download.
  • ready
    Report fully processed by Paddle and ready for download.
  • failed
    There was a problem processing this report.
  • expired
    Report has expired and is no longer accessible.
rowsinteger | nullrequired
Number of records in this report. null if the report is pending.
expires_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string.
updated_atstring (date-time)required
Example: 2024-10-13T07:20:50.52Z
RFC 3339 datetime string of when this report was last updated.
created_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this report was created.
typestringrequired
Example: discounts
Type of report to create.
Values
  • discounts
    Discounts reports contain information about your product and checkout discounts.
filtersarrayrequired
Filter criteria for this report. If omitted, reports are filtered to include data updated in the last 30 days. This means updated_at is greater than or equal to (gte) the date 30 days ago from the time the report was generated.
Items: max 10
namestringrequired
Field name to filter by.
Values
  • type
    Filter by discount type. Pass an array of strings containing any valid value for the type field against a discount.
  • status
    Filter by discount status. Pass an array of strings containing any valid value for the status field against a discount.
  • updated_at
    Filter by discount updated date. Pass an RFC 3339 datetime string.
operatorstring | nullrequired
Example: lt
Operator to use when filtering.
Values
  • lt
    Less than.
  • gte
    Greater than or equal to.
valuerequired
Value to filter by. Check the allowed values descriptions for the name field to see valid values for a field.
Array of string
string
report.updated
{
  "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"
  }
}

Was this page helpful?