ExchangeRate.php 1.4 KB

123456789101112131415161718192021222324252627282930
  1. <?php
  2. // File generated from our OpenAPI spec
  3. namespace Stripe;
  4. /**
  5. * <code>Exchange Rate</code> objects allow you to determine the rates that Stripe
  6. * is currently using to convert from one currency to another. Since this number is
  7. * variable throughout the day, there are various reasons why you might want to
  8. * know the current rate (for example, to dynamically price an item for a user with
  9. * a default payment in a foreign currency).
  10. *
  11. * If you want a guarantee that the charge is made with a certain exchange rate you
  12. * expect is current, you can pass in <code>exchange_rate</code> to charges
  13. * endpoints. If the value is no longer up to date, the charge won't go through.
  14. * Please refer to our <a href="https://stripe.com/docs/exchange-rates">Exchange
  15. * Rates API</a> guide for more details.
  16. *
  17. * @property string $id Unique identifier for the object. Represented as the three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a> in lowercase.
  18. * @property string $object String representing the object's type. Objects of the same type share the same value.
  19. * @property \Stripe\StripeObject $rates Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency.
  20. */
  21. class ExchangeRate extends ApiResource
  22. {
  23. const OBJECT_NAME = 'exchange_rate';
  24. use ApiOperations\All;
  25. use ApiOperations\Retrieve;
  26. }