| object | string | Value is “Refund” |
| id | string | A merchant-specified unique identifier. Optionally, this object can be identified by its vid. Excepting externally “reported” refunds, this is ready-only, this field will be assigned by Subscribe. |
| vid | string | A Globally Unique Identifier (GUID) for this object. This field is created by Subscribe. |
| created | datetime | The date/time at which the refund was requested. |
| transaction | Transaction | The transaction to refund. |
| refund_items | Refund Item | For item-level refunds, specifies the transaction items to refund with details. |
| refund_distribution_strategy | enum | Defines strategy for distributing refund amount across the original TransactionItems. Can be - None -applies the refund using the Transaction-level approach, which applies a refund against a Transaction as a whole, grouping all individual purchases (or line items) into a single Transaction amount. Note: once you partially refund a particular Transaction using the Transaction-level approach, you must continue to use this same approach on subsequent refunds on that original Transaction. Any attempt at a SpecifiedItems or RemainingBalance refund against a Transaction in which the older Transaction-level refund has been performed will return an error. Important: Transaction-level refunds feed back to the payment provider but do not flow through the tax vendor service. - SpecifiedItems - designates a refund for any or all of the purchased items on the original transaction. When applying the refund, you can either specify TaxOnly for the item, or you can specify an amount to affect a full or partial refund at the item level. If you specify an amount, it cannot exceed the original TransactionItem amount (minus any discounts, and minus the sum of all prior refunds against this item). Also, when you specify items, you must pass RefundItem with the details of how to refund each item—if you select either None or RemainingBalance, you do not need to provide RefundItems. - RemainingBalance - refunds the balance remaining (at the line item-level) for the original Transaction. Default: None |
| amount | decimal | Amount of the refund. Must be positive (non-zero) and less than or equal to the as-yet-un-refunded balance of the specified transaction. Ignored if refundItems are specified. |
| amount_includes_tax | boolean | Specifies whether the amount is tax-inclusive (1) or -exclusive |
| currency | string | ISO 4217 Currency Code of this transaction; defaults to USD. |
| metadata | hash | A set of key/value pairs that you can attach to an object. Useful for storing additional information. |
| reference_string | string | Read-only. Information provided by payment processor. |
| note | string | Free-form merchant-specified notes about refund. |
| token_action | enum | Action to take with any Tokens paid on transaction. Default: None. Values can be CancelNegativeBalance, CancelZeroBalance, None |
| credit | Credit | Read-only. Credits reversed by refund. |
| status | enum | Processing status of refund. Values can be Complete, Failed, Processing, Reported |
