OrderReturn.php 1.6 KB

1234567891011121314151617181920212223242526272829303132
  1. <?php
  2. // File generated from our OpenAPI spec
  3. namespace Stripe;
  4. /**
  5. * A return represents the full or partial return of a number of <a
  6. * href="https://stripe.com/docs/api#order_items">order items</a>. Returns always
  7. * belong to an order, and may optionally contain a refund.
  8. *
  9. * Related guide: <a
  10. * href="https://stripe.com/docs/orders/guide#handling-returns">Handling
  11. * Returns</a>.
  12. *
  13. * @property string $id Unique identifier for the object.
  14. * @property string $object String representing the object's type. Objects of the same type share the same value.
  15. * @property int $amount 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.
  16. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
  17. * @property string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>.
  18. * @property \Stripe\OrderItem[] $items The items included in this order return.
  19. * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
  20. * @property null|string|\Stripe\Order $order The order that this return includes items from.
  21. * @property null|string|\Stripe\Refund $refund The ID of the refund issued for this return.
  22. */
  23. class OrderReturn extends ApiResource
  24. {
  25. const OBJECT_NAME = 'order_return';
  26. use ApiOperations\All;
  27. use ApiOperations\Retrieve;
  28. }