Skip to main content
When Plane returns funds back to your company, we will do that through a Refund object. You can think of refunds as inverse charges, or as a Payment where the recipient is your company, not one of your workers. Refunds are most commonly used when you create a Payment and subsequently cancel it, after the Charge linked to that Payment already started to process.

Attributes

string
Unique identifier for the refund.
string
Date the refund was created or scheduled.
string
Amount returned to your company in decimal format.
string
Three-letter ISO currency code, in uppercase.
string
Optional reference attached to the refund.
string
Optional memo attached to the refund.
string
Current refund status, such as draft, pending, succeeded, or failed.
string
The ID of the funding source connected to the refund.
string
The ID of the legal entity receiving the refund.