class Stripe::ExchangeRatesApi
- Stripe::ExchangeRatesApi
- Reference
- Object
Defined in:
stripe/api/exchange_rates_api.crConstant Summary
-
GET_EXCHANGE_RATES_MAX_LENGTH_FOR_ENDING_BEFORE =
5000 -
GET_EXCHANGE_RATES_MAX_LENGTH_FOR_STARTING_AFTER =
5000 -
GET_EXCHANGE_RATES_RATE_ID_MAX_LENGTH_FOR_RATE_ID =
5000
Constructors
Instance Method Summary
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_get_exchange_rates(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_exchange_rates_rate_id(*, rate_id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#get_exchange_rates(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::ExchangeRateList
Returns a list of objects that contain the rates at which foreign currencies are converted to one another.
-
#get_exchange_rates(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Returns a list of objects that contain the rates at which foreign currencies are converted to one another.
-
#get_exchange_rates_rate_id(*, rate_id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::ExchangeRate
Retrieves the exchange rates from the given currency to every supported currency.
@required @param rate_id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. -
#get_exchange_rates_rate_id(*, rate_id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves the exchange rates from the given currency to every supported currency.</p> @required @param rate_id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_exchange_rates_rate_id_with_http_info(*, rate_id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::ExchangeRate, Int32, Hash(String, Array(String) | String))
<p>Retrieves the exchange rates from the given currency to every supported currency.</p> @required @param rate_id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_exchange_rates_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::ExchangeRateList, Int32, Hash(String, Array(String) | String))
<p>Returns a list of objects that contain the rates at which foreign currencies are converted to one another.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.
@optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with the exchange rate for currency X, your subsequent call can include `starting_after=X` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::ExchangeRateList]<p>Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with the exchange rate for currency X, your subsequent call can include starting_after=X in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Retrieves the exchange rates from the given currency to every supported currency.
@required @param rate_id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::ExchangeRate]<p>Retrieves the exchange rates from the given currency to every supported currency.</p> @required @param rate_id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves the exchange rates from the given currency to every supported currency.</p> @required @param rate_id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::ExchangeRate, Integer, Hash)] Stripe::ExchangeRate, response status code and response headers
<p>Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with the exchange rate for currency X, your subsequent call can include starting_after=X in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::ExchangeRateList, Integer, Hash)] Stripe::ExchangeRateList, response status code and response headers