Etsy · Schema

PaymentAdjustmentItem

A payment adjustment line item for a payment adjustment.

MarketplaceEcommerceHandmadeListingsOrdersPaymentsReviewsShippingTaxonomyOAuth2

Properties

Name	Type	Description
payment_adjustment_id	integer	The numeric ID for a payment adjustment.
payment_adjustment_item_id	integer	Unique ID for the adjustment line item.
adjustment_type	string	String indicating the type of adjustment for this line item.
amount	integer	Integer value for the amount of the adjustment in original currency.
shop_amount	integer	Integer value for the amount of the adjustment in currency for the shop.
transaction_id	integer	The unique numeric ID for a transaction.
bill_payment_id	integer	Unique ID for the bill payment adjustment.
created_timestamp	integer	The transaction's creation date and time, in epoch seconds.
updated_timestamp	integer	The update date and time the payment adjustment in epoch seconds.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "PaymentAdjustmentItem",
  "description": "A payment adjustment line item for a payment adjustment.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/etsy/refs/heads/main/json-schema/open-api-v3-payment-adjustment-item-schema.json",
  "type": "object",
  "properties": {
    "payment_adjustment_id": {
      "type": "integer",
      "description": "The numeric ID for a payment adjustment.",
      "format": "int64",
      "minimum": 1,
      "example": 1
    },
    "payment_adjustment_item_id": {
      "type": "integer",
      "description": "Unique ID for the adjustment line item.",
      "format": "int64",
      "minimum": 1,
      "example": 1
    },
    "adjustment_type": {
      "type": "string",
      "description": "String indicating the type of adjustment for this line item.",
      "nullable": true,
      "example": "example string"
    },
    "amount": {
      "type": "integer",
      "description": "Integer value for the amount of the adjustment in original currency.",
      "default": 0,
      "example": 2500
    },
    "shop_amount": {
      "type": "integer",
      "description": "Integer value for the amount of the adjustment in currency for the shop.",
      "default": 0,
      "example": 2500
    },
    "transaction_id": {
      "type": "integer",
      "description": "The unique numeric ID for a transaction.",
      "format": "int64",
      "nullable": true,
      "minimum": 1,
      "example": 345678901
    },
    "bill_payment_id": {
      "type": "integer",
      "description": "Unique ID for the bill payment adjustment.",
      "format": "int64",
      "nullable": true,
      "minimum": 1,
      "example": 1
    },
    "created_timestamp": {
      "type": "integer",
      "description": "The transaction's creation date and time, in epoch seconds.",
      "minimum": 946684800,
      "example": 1758153645
    },
    "updated_timestamp": {
      "type": "integer",
      "description": "The update date and time the payment adjustment in epoch seconds.",
      "minimum": 946684800,
      "example": 1758153645
    }
  }
}