adjustment.updated

Occurs when an adjustment is updated.

This only occurs for refund adjustments, which must be approved by Paddle and are created as pending_approval initially. On review, they move to approved or rejected and adjustment.updated occurs.

event_idstring

Unique Paddle ID for this event, prefixed with evt_.

event_typestring

Type of event sent by Paddle, in the format entity.event_type.

occurred_atstring<date-time>

RFC 3339 datetime string of when this event occurred.

dataobject

New or changed entity.

idstring

Unique Paddle ID for this adjustment entity, prefixed with adj_.

actionstring

How this adjustment impacts the related transaction. refund adjustments must be approved by Paddle, and are created with the status pending_approval.

transaction_idstring

Paddle ID for the transaction related to this adjustment, prefixed with txn_.

subscription_idstring or null

Paddle ID for the subscription related to this adjustment, prefixed with sub_. Set automatically by Paddle based on the subscription_id of the related transaction.

customer_idstring

Paddle ID for the customer related to this adjustment, prefixed with ctm_. Set automatically by Paddle based on the customer_id of the related transaction.

reasonstring

Why this adjustment was created. Appears in the Paddle Dashboard. Retained for record-keeping purposes.

credit_applied_to_balanceboolean or null

Whether this adjustment was applied to the related customer's credit balance. Only returned for credit adjustments.

false when the related transaction collection_mode is manual and its status is billed. The adjustment is used to reduce the balance due on the transaction.

true for automatically-collected transactions and completed manually-collected transactions.

currency_codestring

Three-letter ISO 4217 currency code for this adjustment. Set automatically by Paddle based on the currency_code of the related transaction.

statusstring

Status of this adjustment. Set automatically by Paddle.

refund adjustments must be approved by Paddle, and are created with the status pending_approval until they move to approved or rejected on review. Other kinds of adjustment do not need approval, so are created with the status approved.

itemsarray[object]

List of items on this adjustment.

totalsobject

Breakdown of the total for an adjustment.

payout_totalsobject or null

Breakdown of how this adjustment affects your payout balance.

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.

notification_idstring

Unique Paddle ID for this notification, prefixed with ntf_.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
1{
2  "event_id": "evt_01hvgfdfepj8eaevsjh5g4swbe",
3  "event_type": "adjustment.updated",
4  "occurred_at": "2024-04-15T08:54:10.646377Z",
5  "notification_id": "ntf_01hvgfdfhwncqrrjz1nz5eky9a",
6  "data": {
7    "id": "adj_01hvgf2s84dr6reszzg29zbvcm",
8    "items": [
9      {
10        "id": "adjitm_01hvgf2s84dr6reszzg2gx70gj",
11        "type": "partial",
12        "amount": "100",
13        "totals": {
14          "tax": "8",
15          "total": "100",
16          "subtotal": "92"
17        },
18        "item_id": "txnitm_01hvcc94b7qgz60qmrqmbm19zw",
19        "proration": null
20      }