The refund object

<div class="APISectionHeader">
  <strong>Attributes</strong>
</div>

<div class="attributes">
  <dl>
    <dt>
      <span class="label">id</span>
      <span class="type">string</span>
    </dt>
    <dd>Unique identifier for the object</dd>

    <dt>
      <span class="label">object</span>
      <span class="type">string, value is "refund"</span>
    </dt>
    <dd>A string representing the object’s type. Objects of the same type share the same value.</dd>

    <dt>
      <span class="label">amount</span>
      <span class="type">integer</span>
    </dt>
    <dd>The amount of this Refund.</dd>

    <dt>
      <span class="label">createdAt</span>
      <span class="type">timestamp</span>
    </dt>
    <dd>Time at which the object was created. Measured in milliseconds since the Unix epoch.</dd>

    <dt>
      <span class="label">currency</span>
      <span class="type">string</span>
    </dt>
    <dd>Three-letter ISO currency code, in lowercase. Must be a supported currency.</dd>

    <dt>
      <span class="label">description</span>
      <span class="type">string</span>
    </dt>
    <dd>An arbitrary - ideally descriptive - long form explanation of the Refund, meant to be displayed to the customer.</dd>

    <dt>
      <span class="label">lineItems</span>
      <span class="type">list of strings</span>
    </dt>
    <dd>A list of the IDs of the Line Items of the original Payment this Refund is on.</dd>

    <dt>
      <span class="label">metadata</span>
      <span class="type">hash</span>
    </dt>
    <dd>Set of <a target="_self" href="/reference/metadata">key-value pairs</a> that you can attach to the Refund object.</dd>

    <dt>
      <span class="label">payment</span>
      <span class="type">string</span>
    </dt>
    <dd>The ID of the Payment this Refund is on.</dd>

    <dt>
      <span class="label">reason</span>
      <span class="type">enum</span>
    </dt>
    <dd>
      The reason of the Refund.
      <div class="values-list-container">
        <div class="values-list-header">Possible enum values</div>
        <ul class="values-list">
          <li class="values-list-item">
            <span class="values-list-item-value">
              <code>requested_by_customer</code>
            </span>
            <p class="values-list-item-description">The refund was created due to request from the customer.</p>
          </li>
          <li class="values-list-item">
            <span class="values-list-item-value">
              <code>fraudulent</code>
            </span>
            <p class="values-list-item-description">The refund was created because the original order was fraudulent</p>
          </li>
        </ul>
      </div>
    </dd>

    <dt>
      <span class="label">reference</span>
      <span class="type">string</span>
    </dt>
    <dd>A - ideally unique - string to reference the Refund (e.g. a customer ID, a cart ID, etc.) which can be used to reconcile the Refund with your internal systems.</dd>

    <dt>
      <span class="label">status</span>
      <span class="type">enum</span>
    </dt>
    <dd>
      The status of the Refund.
      <div class="values-list-container">
        <div class="values-list-header">Possible enum values</div>
        <ul class="values-list">
          <li class="values-list-item">
            <span class="values-list-item-value">
              <code>succeeded</code>
            </span>
            <p class="values-list-item-description">The refund was processed successfully.</p>
          </li>
          <li class="values-list-item">
            <span class="values-list-item-value">
              <code>failed</code>
            </span>
            <p class="values-list-item-description">There was an error processing this refund.</p>
          </li>
        </ul>
      </div>
    </dd>

    <dt>
      <span class="label">test</span>
      <span class="type">boolean</span>
    </dt>
    <dd>A flag with a value <code>false</code> if the object exists in live mode or <code>true</code> if the object exists in test mode.</dd>

    <dt>
      <span class="label">updatedAt</span>
      <span class="type">timestamp</span>
    </dt>
    <dd>Time at which the object was last updated. Measured in milliseconds since the Unix epoch.</dd>
  </dl>
</div>