{
   "data": {
     "type": "Refund",
     "id": "d0cb3edd-63ee-4140-a290-604b6d24247b",
     "external_id": "1",
     "refunded_amount": 10,
     "fee": 1,
     "completed_at": "2024-01-01T00:00:00Z",
     "method": "CREDIT_CARD",
     "processor": "Cherry",
     "invoice_id": null,
     "invoice_line_item_id": null,
     "invoice_payment_id": null,
     "recipient_name": "customer-1",
     "customer": {
       "id": "e96594d7-ab6a-44f7-a746-04a73792dd55",
       "external_id": "customer-1",
       "individual_name": "John Doe",
       "company_name": "Acme, Inc.",
       "email": null,
       "mobile_phone": null,
       "office_phone": null,
       "address_string": null,
       "notes": null,
       "status": "ACTIVE"
     }
  },
   "meta": {}
 }
A refund represents a transaction that returns value from a business to a customer. A individual payment can be refunded entirely or a general refund can be applied to an invoice.

​
Attributes

​
id
string
required
Unique identifier for the refund.
​
external_id
string
Unique ID of the refund in your system for linking and idempotency.
​
type
string
required
Resource type. Value will be “Refund”.
​
completed_at
ISO8601 timestamp
required
Timestamp when refund posted.
​
refunded_amount
integer
required
Amount of refund received by customer.
​
fee
integer
Fee, in cents, charged by payment processor for the refund.
​
method
enum
required
Payment method. Possible values are: CASH, CHECK, CREDIT_CARD, ACH, STORE_CREDIT, OTHER
​
processor
string
Processor used to make the payment, if any. Any processor name can be provided and will be tracked.
​
customer
Customer object
Customer object associated with the invoice.
​
invoice_id
string
Invoice ID this refund was applied to, if applicable. This field does not need to be specified, but if invoice_line_item_id is also specified, it must belong to this invoice.
​
invoice_line_item_id
string
Invoice line item ID specifying an exact product or service which was refunded.
​
invoice_payment_id
string
Payment ID this refund was applied to, if applicable.
 {
   "data": {
     "type": "Refund",
     "id": "d0cb3edd-63ee-4140-a290-604b6d24247b",
     "external_id": "1",
     "refunded_amount": 10,
     "fee": 1,
     "completed_at": "2024-01-01T00:00:00Z",
     "method": "CREDIT_CARD",
     "processor": "Cherry",
     "invoice_id": null,
     "invoice_line_item_id": null,
     "invoice_payment_id": null,
     "recipient_name": "customer-1",
     "customer": {
       "id": "e96594d7-ab6a-44f7-a746-04a73792dd55",
       "external_id": "customer-1",
       "individual_name": "John Doe",
       "company_name": "Acme, Inc.",
       "email": null,
       "mobile_phone": null,
       "office_phone": null,
       "address_string": null,
       "notes": null,
       "status": "ACTIVE"
     }
  },
   "meta": {}
 }