# order\_return

From **Stripe API**.

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).

- Type: `object`

## Properties

### `amount`

- Required: true
- Type: `integer`

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`

- Required: true
- Type: `integer`
- Format: `unix-time`

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

### `currency`

- Required: true
- Type: `string`

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`

- Required: true
- Type: `string`
- maxLength: `5000`

Unique identifier for the object.

### `items`

- Required: true
- Type: `array`

The items included in this order return.

### `livemode`

- Required: true
- Type: `boolean`

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

### `object`

- Required: true
- Type: `string`
- Allowed values: `"order_return"`

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

### `order`

- Required: false
- Nullable: true

The order that this return includes items from.

### `refund`

- Required: false
- Nullable: true

The ID of the refund issued for this return.

## JSON Schema

```json
{"description":"A return represents the full or partial return of a number of [order items](https://stripe.com/docs/api#order_items).\nReturns always belong to an order, and may optionally contain a refund.\n\nRelated guide: [Handling Returns](https://stripe.com/docs/orders/guide#handling-returns).","properties":{"amount":{"description":"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.","type":"integer"},"created":{"description":"Time at which the object was created. Measured in seconds since the Unix epoch.","format":"unix-time","type":"integer"},"currency":{"description":"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).","type":"string"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"items":{"description":"The items included in this order return.","items":{"$ref":"#/components/schemas/order_item"},"type":"array"},"livemode":{"description":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","type":"boolean"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["order_return"],"type":"string"},"order":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/order"}],"description":"The order that this return includes items from.","nullable":true,"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/order"}]}},"refund":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/refund"}],"description":"The ID of the refund issued for this return.","nullable":true,"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/refund"}]}}},"required":["amount","created","currency","id","items","livemode","object"],"title":"OrderReturn","type":"object","x-expandableFields":["items","order","refund"],"x-resourceId":"order_return"}
```