Skip to main content
Manja / Stripe
Schema2020-08-27object

order_return

A return represents the full or partial return of a number of [order items](https://stripe.com/docs/api#order_items). Returns always belong to an order, and may optionally contain a refund. Related guide: [Handling Returns](https://stripe.com/docs/orders/guide#handling-returns).

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

OrderReturn

object

A return represents the full or partial return of a number of [order items](https://stripe.com/docs/api#order_items). Returns always belong to an order, and may optionally contain a refund. Related guide: [Handling Returns](https://stripe.com/docs/orders/guide#handling-returns).

amount integer
required

A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the returned line item.

created integer (unix-time)
required

Time at which the object was created. Measured in seconds since the Unix epoch.

currency string
required

Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

id string
required

Unique identifier for the object.

maxLength:5000

items array
required

The items included in this order return.

livemode boolean
required

Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

object string
required

String representing the object's type. Objects of the same type share the same value.

Allowed: "order_return"

order
optionalnullable

The order that this return includes items from.

refund
optionalnullable

The ID of the refund issued for this return.