adjustment.created

Occurs when an adjustment is created.

dataobject

New or changed entity.

idstring

Reference for the adjustment

actionstring

This parameter indicates the type of adjustment that will be created. Partial and full refunds can be requested, but needs approval from Paddle. Tax refunds, chargeback and chargeback_warning are reserved for Paddle internal users.

typestring or null

Type of adjustment. Use full to adjust the grand total for the related transaction. Include an items array when creating a partial adjustment. If omitted, defaults to partial.

transaction_idstring

ID of the Transaction that this adjustment belongs to

subscription_idstring or null

ID of the Subscription that this adjustment belongs to

customer_idstring

ID of the Customer that this Transaction is for

reasonstring

Some context on why the adjustment is being performed

credit_applied_to_balanceboolean or null

When the Transaction collection mode is manual and the status is billed, this field is false. If it is true, it indicates that credits have been applied to the customer's balance. Otherwise, the adjustment is used to decrease the total amount of a billed invoice Transaction.

currency_codestring

Supported three-letter ISO 4217 currency code.

statusstring

Status for an adjustment. Pending approval is read-only and cannot be set. Approved and Rejected are both final states for an adjustment.

itemsarray[object]

totalsobject

Breakdown of the total for an adjustment.

payout_totalsobject or null

Breakdown of how this adjustment affects your payout balance.

tax_rates_usedarray[object] or null

List of tax rates applied for this adjustment.

created_atstring<date-time>

Timestamp following the RFC 3339 standard. This is set by the system, and cannot be changed via the API.

updated_atstring<date-time>

Timestamp following the RFC 3339 standard. This is set by the system, and cannot be changed via the API.

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.

notification_idstring

Unique Paddle ID for this notification, prefixed with ntf_.

occurred_atstring<date-time>

RFC 3339 datetime string of when this event occurred.

Request

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_01hvgf2skkg8dsk5dczemw2bx1",
3  "event_type": "adjustment.created",
4  "occurred_at": "2024-04-15T08:48:20.595926Z",
5  "notification_id": "ntf_01hvgf2spk3bvewnw8t2zrnbmb",
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      }

AI AssistantBeta

Ask a question to start a conversation!

If you have made a purchase through Paddle, go to paddle.net instead.

Protected by hCaptcha