> For the complete documentation index, see [llms.txt](https://developer.paddle.com/llms.txt). # adjustment.updated Occurs when an adjustment is 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. ## 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": { "properties": { "id": { "type": "string", "pattern": "^adj_[a-z\\d]{26}$", "description": "Reference for the adjustment", "title": "Adjustment ID", "examples": [ "adj_01ghvjt9dbpnndeqjve8cktgqs" ] }, "action": { "type": "string", "enum": [ "credit", "refund", "chargeback", "chargeback_reverse", "chargeback_warning", "chargeback_warning_reverse", "credit_reverse" ], "description": "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.", "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": { "anyOf": [ { "type": "string", "enum": [ "full", "partial" ], "description": "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`.", "title": "AdjustmentType", "examples": [ "partial" ], "x-enum-descriptions": { "full": { "description": "The grand total for the related transaction is adjusted." }, "partial": { "description": "Some line items for the related transaction are adjusted. Requires `items`." } } }, { "type": "null" } ], "description": "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_id": { "type": "string", "pattern": "^txn_[a-z\\d]{26}$", "description": "ID of the Transaction that this adjustment belongs to", "title": "Transaction ID", "examples": [ "txn_01ghvjq8hbjyf4cyfkqxa676pq" ] }, "subscription_id": { "anyOf": [ { "type": "string", "pattern": "^sub_[a-z\\d]{26}$", "description": "Unique Paddle ID for this subscription entity, prefixed with `sub_`.", "title": "Subscription ID", "examples": [ "sub_01h04vsc0qhwtsbsxh3422wjs4" ] }, { "type": "null" } ], "description": "ID of the Subscription that this adjustment belongs to", "examples": [ "sub_01ghbmdabe7ra1v26qjpehd191" ] }, "customer_id": { "type": "string", "pattern": "^ctm_[a-z\\d]{26}$", "description": "ID of the Customer that this Transaction is for", "title": "Customer ID", "examples": [ "ctm_01ghbm8g2qxsjp07p5ywsy61cs" ] }, "reason": { "type": "string", "description": "Some context on why the adjustment is being performed" }, "credit_applied_to_balance": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "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_code": { "type": "string", "enum": [ "USD", "EUR", "GBP", "JPY", "AUD", "CAD", "CHF", "HKD", "SGD", "SEK", "ARS", "BRL", "CLP", "CNY", "COP", "CZK", "DKK", "HUF", "ILS", "INR", "KRW", "MXN", "NOK", "NZD", "PEN", "PLN", "RUB", "THB", "TRY", "TWD", "UAH", "VND", "ZAR" ], "description": "Supported three-letter ISO 4217 currency code.", "title": "Currency code", "x-enum-descriptions": { "USD": { "description": "United States Dollar" }, "EUR": { "description": "Euro" }, "GBP": { "description": "Pound Sterling" }, "JPY": { "description": "Japanese Yen" }, "AUD": { "description": "Australian Dollar" }, "CAD": { "description": "Canadian Dollar" }, "CHF": { "description": "Swiss Franc" }, "HKD": { "description": "Hong Kong Dollar" }, "SGD": { "description": "Singapore Dollar" }, "SEK": { "description": "Swedish Krona" }, "ARS": { "description": "Argentine Peso" }, "BRL": { "description": "Brazilian Real" }, "CLP": { "description": "Chilean Peso" }, "CNY": { "description": "Chinese Yuan" }, "COP": { "description": "Colombian Peso" }, "CZK": { "description": "Czech Koruna" }, "DKK": { "description": "Danish Krone" }, "HUF": { "description": "Hungarian Forint" }, "ILS": { "description": "Israeli Shekel" }, "INR": { "description": "Indian Rupee" }, "KRW": { "description": "South Korean Won" }, "MXN": { "description": "Mexican Peso" }, "NOK": { "description": "Norwegian Krone" }, "NZD": { "description": "New Zealand Dollar" }, "PEN": { "description": "Peruvian Sol" }, "PLN": { "description": "Polish Zloty" }, "RUB": { "description": "Russian Ruble" }, "THB": { "description": "Thai Baht" }, "TRY": { "description": "Turkish Lira" }, "TWD": { "description": "New Taiwan Dollar" }, "UAH": { "description": "Ukrainian Hryvnia" }, "VND": { "description": "Vietnamese Dong" }, "ZAR": { "description": "South African Rand" } } }, "status": { "type": "string", "enum": [ "pending_approval", "approved", "rejected", "reversed" ], "description": "Status for an adjustment. Pending approval is read-only and cannot be set. Approved and Rejected are both final states for an adjustment.", "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." } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^adjitm_[a-z\\d]{26}$", "description": "Unique Paddle ID for this adjustment item, prefixed with `adjitm_`.", "title": "Adjustment item ID", "examples": [ "adjitm_01gw4rs4kex0prncwfne87ft8x" ] }, "item_id": { "type": "string", "pattern": "^txnitm_[a-z\\d]{26}$", "description": "Paddle ID for the transaction item that this adjustment item relates to, prefixed with `txnitm_`.", "title": "Transaction item ID", "examples": [ "txnitm_01gm302t81w94gyjpjpqypkzkf" ] }, "type": { "type": "string", "enum": [ "full", "partial", "tax", "proration" ], "description": "Type of adjustment for this transaction item. `tax` adjustments are automatically created by Paddle.\nInclude `amount` when creating a `partial` adjustment.", "title": "AdjustmentItemType", "examples": [ "full" ], "x-enum-descriptions": { "full": { "description": "Full total for this transaction item is adjusted." }, "partial": { "description": "Part of this transaction item is adjusted. Include `amount` to specify the partial amount adjusted." }, "tax": { "description": "Tax for this transaction item is adjusted. Created automatically by Paddle." }, "proration": { "description": "A prorated amount for this transaction item is adjusted. Created automatically by Paddle in some cases when making changes to a subscription.", "deprecated": true } } }, "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Amount adjusted for this transaction item. Required when item `type` is `partial`." }, "proration": { "anyOf": [ { "type": "object", "required": [ "rate", "billing_period" ], "properties": { "rate": { "type": "string", "description": "Rate used to calculate proration.", "x-external-readOnly": true }, "billing_period": { "properties": { "starts_at": { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string of when this period starts.", "title": "Timestamp", "examples": [ "2024-10-12T07:20:50.52Z" ] }, "ends_at": { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string of when this period ends.", "title": "Timestamp", "examples": [ "2024-10-12T07:20:50.52Z" ] } }, "required": [ "starts_at", "ends_at" ], "type": "object", "title": "Time period", "description": "Billing period that proration is based on.", "x-external-readOnly": true } }, "description": "How proration was calculated for this item. Populated when a transaction is created from a subscription change, where `proration_billing_mode` was `prorated_immediately` or `prorated_next_billing_period`. Set automatically by Paddle.", "title": "Proration" }, { "type": "null" } ], "description": "How proration was calculated for this adjustment item." }, "totals": { "properties": { "subtotal": { "type": "string", "description": "Amount multiplied by quantity.", "examples": [ "15000" ] }, "tax": { "type": "string", "description": "Total tax on the subtotal.", "examples": [ "1500" ] }, "total": { "type": "string", "description": "Total after tax.", "examples": [ "16500" ] } }, "required": [ "subtotal", "tax", "total" ], "type": "object", "description": "Breakdown of the total for an adjustment item.", "title": "Adjustment item totals" } }, "required": [ "id", "item_id", "type", "amount", "proration", "totals" ] } }, "totals": { "type": "object", "required": [ "subtotal", "tax", "total", "fee", "earnings", "currency_code" ], "properties": { "subtotal": { "type": "string", "description": "Total before tax. For tax adjustments, the value is 0.", "examples": [ "15000" ] }, "tax": { "type": "string", "description": "Total tax on the subtotal.", "examples": [ "1500" ] }, "total": { "type": "string", "description": "Total after tax.", "examples": [ "16500" ] }, "fee": { "type": "string", "description": "Total fee taken by Paddle for this adjustment.", "examples": [ "300" ] }, "retained_fee": { "type": "string", "description": "Paddle fees retained for this adjustment.", "examples": [ "300" ] }, "earnings": { "type": "string", "description": "Total earnings. This is the subtotal minus the Paddle fee.\nFor tax adjustments, this value is negative, which means a positive effect in the transaction earnings.\nThis is because the fee is originally calculated from the transaction total, so if a tax adjustment is made,\nthen the fee portion of it is returned.", "examples": [ "14700" ] }, "currency_code": { "type": "string", "enum": [ "USD", "EUR", "GBP", "JPY", "AUD", "CAD", "CHF", "HKD", "SGD", "SEK", "ARS", "BRL", "CLP", "CNY", "COP", "CZK", "DKK", "HUF", "ILS", "INR", "KRW", "MXN", "NOK", "NZD", "PEN", "PLN", "RUB", "THB", "TRY", "TWD", "UAH", "VND", "ZAR" ], "description": "Three-letter ISO 4217 currency code used for this adjustment.", "title": "Currency code", "x-enum-descriptions": { "USD": { "description": "United States Dollar" }, "EUR": { "description": "Euro" }, "GBP": { "description": "Pound Sterling" }, "JPY": { "description": "Japanese Yen" }, "AUD": { "description": "Australian Dollar" }, "CAD": { "description": "Canadian Dollar" }, "CHF": { "description": "Swiss Franc" }, "HKD": { "description": "Hong Kong Dollar" }, "SGD": { "description": "Singapore Dollar" }, "SEK": { "description": "Swedish Krona" }, "ARS": { "description": "Argentine Peso" }, "BRL": { "description": "Brazilian Real" }, "CLP": { "description": "Chilean Peso" }, "CNY": { "description": "Chinese Yuan" }, "COP": { "description": "Colombian Peso" }, "CZK": { "description": "Czech Koruna" }, "DKK": { "description": "Danish Krone" }, "HUF": { "description": "Hungarian Forint" }, "ILS": { "description": "Israeli Shekel" }, "INR": { "description": "Indian Rupee" }, "KRW": { "description": "South Korean Won" }, "MXN": { "description": "Mexican Peso" }, "NOK": { "description": "Norwegian Krone" }, "NZD": { "description": "New Zealand Dollar" }, "PEN": { "description": "Peruvian Sol" }, "PLN": { "description": "Polish Zloty" }, "RUB": { "description": "Russian Ruble" }, "THB": { "description": "Thai Baht" }, "TRY": { "description": "Turkish Lira" }, "TWD": { "description": "New Taiwan Dollar" }, "UAH": { "description": "Ukrainian Hryvnia" }, "VND": { "description": "Vietnamese Dong" }, "ZAR": { "description": "South African Rand" } }, "examples": [ "USD" ] } }, "description": "Breakdown of the total for an adjustment.", "title": "AdjustmentTotals" }, "payout_totals": { "anyOf": [ { "type": "object", "required": [ "subtotal", "tax", "total", "fee", "retained_fee", "earnings", "currency_code" ], "properties": { "subtotal": { "type": "string", "description": "Adjustment total before tax and fees.", "examples": [ "15000" ] }, "tax": { "type": "string", "description": "Total tax on the adjustment subtotal.", "examples": [ "1500" ] }, "total": { "type": "string", "description": "Adjustment total after tax.", "examples": [ "16500" ] }, "fee": { "type": "string", "description": "Adjusted Paddle fee.", "examples": [ "300" ] }, "retained_fee": { "type": "string", "description": "Paddle fees retained for this adjustment.", "examples": [ "300" ] }, "chargeback_fee": { "properties": { "amount": { "type": "string", "description": "Chargeback fee converted into the payout currency.", "examples": [ "1680" ] }, "original": { "anyOf": [ { "type": "object", "required": [ "amount", "currency_code" ], "properties": { "amount": { "type": "string", "description": "Fee amount for this chargeback in the original currency.", "examples": [ "1500" ] }, "currency_code": { "type": "string", "enum": [ "AUD", "CAD", "EUR", "GBP", "USD" ], "description": "Three-letter ISO 4217 currency code for the original chargeback fee.", "title": "Currency code (chargebacks)", "x-enum-descriptions": { "AUD": { "description": "Australian Dollar" }, "CAD": { "description": "Canadian Dollar" }, "EUR": { "description": "Euro" }, "GBP": { "description": "Pound Sterling" }, "USD": { "description": "United States Dollar" } }, "examples": [ "USD" ] } } }, { "type": "null" } ], "description": "Chargeback fee before conversion to the payout currency. `null` when the chargeback fee is the same as the payout currency." } }, "required": [ "amount", "original" ], "type": "object", "description": "Chargeback fees incurred for this adjustment. Only returned when the adjustment `action` is `chargeback` or `chargeback_warning`." }, "earnings": { "type": "string", "description": "Adjusted payout earnings. This is the adjustment total plus adjusted Paddle fees, excluding chargeback fees.", "examples": [ "15120" ] }, "currency_code": { "type": "string", "enum": [ "AUD", "CAD", "CHF", "CNY", "CZK", "DKK", "EUR", "GBP", "HUF", "PLN", "SEK", "USD", "ZAR" ], "description": "Three-letter ISO 4217 currency code used for the payout for this transaction. If your primary currency has changed, this reflects the primary currency at the time the transaction was billed.", "title": "Currency code (payouts)", "x-enum-descriptions": { "AUD": { "description": "Australian Dollar" }, "CAD": { "description": "Canadian Dollar" }, "CHF": { "description": "Swiss Franc" }, "CNY": { "description": "Chinese Yuan" }, "CZK": { "description": "Czech Koruna" }, "DKK": { "description": "Danish Krone" }, "EUR": { "description": "Euro" }, "GBP": { "description": "Pound Sterling" }, "HUF": { "description": "Hungarian Forint" }, "PLN": { "description": "Polish Zloty" }, "SEK": { "description": "Swedish Krona" }, "USD": { "description": "United States Dollar" }, "ZAR": { "description": "South African Rand" } } } }, "description": "Breakdown of how this adjustment affects your payout balance.", "title": "Payout totals (adjustment)" }, { "type": "null" } ] }, "tax_rates_used": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "tax_rate", "totals" ], "properties": { "tax_rate": { "type": "string", "description": "Rate used to calculate tax for this adjustment.", "examples": [ "0.2" ] }, "totals": { "properties": { "subtotal": { "type": "string", "description": "Total before tax. For tax adjustments, the value is 0.", "examples": [ "15000" ] }, "tax": { "type": "string", "description": "Total tax on the subtotal.", "examples": [ "1500" ] }, "total": { "type": "string", "description": "Total after tax.", "examples": [ "16500" ] } }, "required": [ "subtotal", "tax", "total" ], "type": "object", "description": "Calculated totals for the tax applied to this adjustment.", "title": "AdjustmentTaxRateUsedTotals" } }, "description": "List of tax rates applied for this adjustment.", "title": "AdjustmentTaxRateUsed" } }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time", "description": "Timestamp following the RFC 3339 standard. This is set by the system, and cannot be changed via the API.", "title": "Created at", "examples": [ "2019-10-12T07:20:50.52Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "Timestamp following the RFC 3339 standard. This is set by the system, and cannot be changed via the API.", "title": "Updated at", "examples": [ "2019-10-12T07:20:50.52Z" ] } }, "required": [ "id", "action", "type", "transaction_id", "subscription_id", "customer_id", "reason", "credit_applied_to_balance", "currency_code", "status", "items", "totals", "payout_totals", "tax_rates_used", "created_at", "updated_at" ], "type": "object", "description": "New or changed entity." } } } ``` ## Example ```json { "event_id": "evt_01hvgfdfepj8eaevsjh5g4swbe", "event_type": "adjustment.updated", "occurred_at": "2024-04-15T08:54:10.646377Z", "notification_id": "ntf_01hvgfdfhwncqrrjz1nz5eky9a", "data": { "id": "adj_01hvgf2s84dr6reszzg29zbvcm", "items": [ { "id": "adjitm_01hvgf2s84dr6reszzg2gx70gj", "type": "partial", "amount": "100", "totals": { "tax": "8", "total": "100", "subtotal": "92" }, "item_id": "txnitm_01hvcc94b7qgz60qmrqmbm19zw", "proration": null } ], "action": "refund", "type": "partial", "reason": "error", "status": "pending_approval", "totals": { "fee": "5", "tax": "8", "total": "100", "earnings": "87", "subtotal": "92", "currency_code": "USD", "retained_fee": "5" }, "created_at": "2024-04-15T08:48:20.239695Z", "updated_at": "2024-04-15T08:54:10.646377Z", "customer_id": "ctm_01hv6y1jedq4p1n0yqn5ba3ky4", "currency_code": "USD", "payout_totals": { "fee": "5", "tax": "8", "total": "100", "earnings": "87", "subtotal": "92", "currency_code": "USD", "retained_fee": "5", "chargeback_fee": { "amount": "0", "original": null } }, "transaction_id": "txn_01hvcc93znj3mpqt1tenkjb04y", "subscription_id": "sub_01hvccbx32q2gb40sqx7n42430", "credit_applied_to_balance": null, "tax_rates_used": null } } ```