PurchaseRefund

A refund returned to you on a purchase.

  • amount
    Type: object · Money
    required

    A monetary amount as a decimal in the currency's major unit paired with its currency code — { amount: 14.99, currency: "USD" } means $14.99.

    • amount
      Type: number
      required

      Decimal amount in the currency's major unit (e.g. 5.23 for €5.23). 2 decimal places for EUR/USD/GBP/CHF/CAD/AUD.

    • currency
      Type: string enum
      required
      values
      • USD

        US Dollar.

      • EUR

        Euro.

      • GBP

        British Pound.

      • CAD

        Canadian Dollar.

      • CHF

        Swiss Franc.

  • refundedAt
    Type: string · DateStringFormat: date-timenullable
    required

    When the refund was issued. null when it is still pending.

    An ISO 8601 date-time in UTC, e.g. 2024-08-14T10:23:11.000Z.