summaryrefslogtreecommitdiffstats
path: root/vendor/stripe/stripe-php/lib/ExchangeRate.php
blob: e23fe3c8197d12add451fdd111ab45afa3c66908 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
<?php

// File generated from our OpenAPI spec

namespace Stripe;

/**
 * <code>Exchange Rate</code> objects allow you to determine the rates that Stripe
 * is currently using to convert from one currency to another. Since this number is
 * variable throughout the day, there are various reasons why you might want to
 * know the current rate (for example, to dynamically price an item for a user with
 * a default payment in a foreign currency).
 *
 * If you want a guarantee that the charge is made with a certain exchange rate you
 * expect is current, you can pass in <code>exchange_rate</code> to charges
 * endpoints. If the value is no longer up to date, the charge won't go through.
 * Please refer to our <a href="https://stripe.com/docs/exchange-rates">Exchange
 * Rates API</a> guide for more details.
 *
 * @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.
 * @property string $object String representing the object's type. Objects of the same type share the same value.
 * @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.
 */
class ExchangeRate extends ApiResource
{
    const OBJECT_NAME = 'exchange_rate';

    use ApiOperations\All;
    use ApiOperations\Retrieve;
}