ApiOperations
1 year ago
Apps
1 year ago
Billing
1 year ago
BillingPortal
1 year ago
Checkout
1 year ago
Climate
1 year ago
Entitlements
1 year ago
EventData
1 year ago
Events
1 year ago
Exception
1 year ago
FinancialConnections
1 year ago
Forwarding
1 year ago
HttpClient
1 year ago
Identity
1 year ago
Issuing
1 year ago
Radar
1 year ago
Reporting
1 year ago
Service
1 year ago
Sigma
1 year ago
Tax
1 year ago
Terminal
1 year ago
TestHelpers
1 year ago
Treasury
1 year ago
Util
1 year ago
V2
1 year ago
Account.php
1 year ago
AccountLink.php
1 year ago
AccountSession.php
1 year ago
ApiRequestor.php
1 year ago
ApiResource.php
2 years ago
ApiResponse.php
2 years ago
ApplePayDomain.php
1 year ago
Application.php
2 years ago
ApplicationFee.php
1 year ago
ApplicationFeeRefund.php
2 years ago
Balance.php
1 year ago
BalanceTransaction.php
1 year ago
BankAccount.php
1 year ago
BaseStripeClient.php
1 year ago
BaseStripeClientInterface.php
1 year ago
Capability.php
1 year ago
Card.php
1 year ago
CashBalance.php
2 years ago
Charge.php
1 year ago
Collection.php
1 year ago
ConfirmationToken.php
1 year ago
ConnectCollectionTransfer.php
2 years ago
CountrySpec.php
1 year ago
Coupon.php
1 year ago
CreditNote.php
1 year ago
CreditNoteLineItem.php
1 year ago
Customer.php
1 year ago
CustomerBalanceTransaction.php
2 years ago
CustomerCashBalanceTransaction.php
2 years ago
CustomerSession.php
1 year ago
Discount.php
1 year ago
Dispute.php
1 year ago
EphemeralKey.php
1 year ago
ErrorObject.php
1 year ago
Event.php
1 year ago
ExchangeRate.php
1 year ago
File.php
1 year ago
FileLink.php
1 year ago
FundingInstructions.php
2 years ago
Invoice.php
1 year ago
InvoiceItem.php
1 year ago
InvoiceLineItem.php
1 year ago
InvoiceRenderingTemplate.php
1 year ago
LineItem.php
1 year ago
LoginLink.php
1 year ago
Mandate.php
1 year ago
OAuth.php
2 years ago
OAuthErrorObject.php
1 year ago
PaymentIntent.php
1 year ago
PaymentLink.php
1 year ago
PaymentMethod.php
1 year ago
PaymentMethodConfiguration.php
1 year ago
PaymentMethodDomain.php
1 year ago
Payout.php
1 year ago
Person.php
1 year ago
Plan.php
1 year ago
Price.php
1 year ago
Product.php
1 year ago
ProductFeature.php
1 year ago
PromotionCode.php
1 year ago
Quote.php
1 year ago
Reason.php
1 year ago
RecipientTransfer.php
2 years ago
Refund.php
1 year ago
RelatedObject.php
1 year ago
RequestTelemetry.php
2 years ago
ReserveTransaction.php
2 years ago
Review.php
1 year ago
SearchResult.php
1 year ago
SetupAttempt.php
1 year ago
SetupIntent.php
1 year ago
ShippingRate.php
1 year ago
SingletonApiResource.php
2 years ago
Source.php
1 year ago
SourceMandateNotification.php
2 years ago
SourceTransaction.php
2 years ago
Stripe.php
1 year ago
StripeClient.php
1 year ago
StripeClientInterface.php
2 years ago
StripeObject.php
1 year ago
StripeStreamingClientInterface.php
2 years ago
Subscription.php
1 year ago
SubscriptionItem.php
1 year ago
SubscriptionSchedule.php
1 year ago
TaxCode.php
1 year ago
TaxDeductedAtSource.php
2 years ago
TaxId.php
1 year ago
TaxRate.php
1 year ago
ThinEvent.php
1 year ago
Token.php
1 year ago
Topup.php
1 year ago
Transfer.php
1 year ago
TransferReversal.php
1 year ago
UsageRecord.php
1 year ago
UsageRecordSummary.php
1 year ago
Webhook.php
1 year ago
WebhookEndpoint.php
1 year ago
WebhookSignature.php
2 years ago
ExchangeRate.php
76 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | namespace WPForms\Vendor\Stripe; |
| 5 | |
| 6 | /** |
| 7 | * <code>ExchangeRate</code> objects allow you to determine the rates that Stripe is currently |
| 8 | * using to convert from one currency to another. Since this number is variable |
| 9 | * throughout the day, there are various reasons why you might want to know the current |
| 10 | * rate (for example, to dynamically price an item for a user with a default |
| 11 | * payment in a foreign currency). |
| 12 | * |
| 13 | * Please refer to our <a href="https://stripe.com/docs/fx-rates">Exchange Rates API</a> guide for more details. |
| 14 | * |
| 15 | * <em>[Note: this integration path is supported but no longer recommended]</em> Additionally, |
| 16 | * you can guarantee that a charge is made with an exchange rate that you expect is |
| 17 | * current. To do so, you must pass in the exchange_rate to charges endpoints. If the |
| 18 | * value is no longer up to date, the charge won't go through. Please refer to our |
| 19 | * <a href="https://stripe.com/docs/exchange-rates">Using with charges</a> guide for more details. |
| 20 | * |
| 21 | * ----- |
| 22 | * |
| 23 | * |
| 24 | * |
| 25 | * <em>This Exchange Rates API is a Beta Service and is subject to Stripe's terms of service. You may use the API solely for the purpose of transacting on Stripe. For example, the API may be queried in order to:</em> |
| 26 | * |
| 27 | * - <em>localize prices for processing payments on Stripe</em> |
| 28 | * - <em>reconcile Stripe transactions</em> |
| 29 | * - <em>determine how much money to send to a connected account</em> |
| 30 | * - <em>determine app fees to charge a connected account</em> |
| 31 | * |
| 32 | * <em>Using this Exchange Rates API beta for any purpose other than to transact on Stripe is strictly prohibited and constitutes a violation of Stripe's terms of service.</em> |
| 33 | * |
| 34 | * @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. |
| 35 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 36 | * @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. |
| 37 | */ |
| 38 | class ExchangeRate extends ApiResource |
| 39 | { |
| 40 | const OBJECT_NAME = 'exchange_rate'; |
| 41 | /** |
| 42 | * Returns a list of objects that contain the rates at which foreign currencies are |
| 43 | * converted to one another. Only shows the currencies for which Stripe supports. |
| 44 | * |
| 45 | * @param null|array $params |
| 46 | * @param null|array|string $opts |
| 47 | * |
| 48 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 49 | * |
| 50 | * @return \Stripe\Collection<\Stripe\ExchangeRate> of ApiResources |
| 51 | */ |
| 52 | public static function all($params = null, $opts = null) |
| 53 | { |
| 54 | $url = static::classUrl(); |
| 55 | return static::_requestPage($url, \WPForms\Vendor\Stripe\Collection::class, $params, $opts); |
| 56 | } |
| 57 | /** |
| 58 | * Retrieves the exchange rates from the given currency to every supported |
| 59 | * currency. |
| 60 | * |
| 61 | * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key |
| 62 | * @param null|array|string $opts |
| 63 | * |
| 64 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 65 | * |
| 66 | * @return \Stripe\ExchangeRate |
| 67 | */ |
| 68 | public static function retrieve($id, $opts = null) |
| 69 | { |
| 70 | $opts = \WPForms\Vendor\Stripe\Util\RequestOptions::parse($opts); |
| 71 | $instance = new static($id, $opts); |
| 72 | $instance->refresh(); |
| 73 | return $instance; |
| 74 | } |
| 75 | } |
| 76 |