StripeAPI.Operations.GetTaxRates

Contains the different functions to run the operation getTaxRates

Documentation

getTaxRates

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Bool

active: Optional flag to filter by tax rates that are either active or not active (archived)

-> Maybe String

created: Optional range for filtering created date

-> Maybe String

ending_before: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. | Constraints: Maximum length of 5000

-> Maybe String

expand: Specifies which fields in the response should be expanded.

-> Maybe Bool

inclusive: Optional flag to filter by tax rates that are inclusive (or those that are not inclusive)

-> Maybe Integer

limit: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

-> Maybe String

starting_after: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. | Constraints: Maximum length of 5000

-> GetTaxRatesRequestBody

The request body to send

-> m (Either HttpException (Response GetTaxRatesResponse))

Monad containing the result of the operation

GET /v1/tax_rates

<p>Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.</p>

getTaxRatesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Bool -> Maybe String -> Maybe String -> Maybe String -> Maybe Bool -> Maybe Integer -> Maybe String -> GetTaxRatesRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/tax_rates

The same as getTaxRates but returns the raw ByteString

getTaxRatesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Bool -> Maybe String -> Maybe String -> Maybe String -> Maybe Bool -> Maybe Integer -> Maybe String -> GetTaxRatesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetTaxRatesResponse))

GET /v1/tax_rates

Monadic version of getTaxRates (use with runWithConfiguration)

getTaxRatesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Bool -> Maybe String -> Maybe String -> Maybe String -> Maybe Bool -> Maybe Integer -> Maybe String -> GetTaxRatesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/tax_rates

Monadic version of getTaxRatesRaw (use with runWithConfiguration)

data GetTaxRatesRequestBody

Defines the data type for the schema getTaxRatesRequestBody

Constructors

GetTaxRatesRequestBody

Instances

Eq GetTaxRatesRequestBody

Defined in StripeAPI.Operations.GetTaxRates

Methods

(==) :: GetTaxRatesRequestBody -> GetTaxRatesRequestBody -> Bool

(/=) :: GetTaxRatesRequestBody -> GetTaxRatesRequestBody -> Bool

Show GetTaxRatesRequestBody

Defined in StripeAPI.Operations.GetTaxRates

Methods

showsPrec :: Int -> GetTaxRatesRequestBody -> ShowS

show :: GetTaxRatesRequestBody -> String

showList :: [GetTaxRatesRequestBody] -> ShowS

ToJSON GetTaxRatesRequestBody

Defined in StripeAPI.Operations.GetTaxRates

Methods

toJSON :: GetTaxRatesRequestBody -> Value

toEncoding :: GetTaxRatesRequestBody -> Encoding

toJSONList :: [GetTaxRatesRequestBody] -> Value

toEncodingList :: [GetTaxRatesRequestBody] -> Encoding

FromJSON GetTaxRatesRequestBody

Defined in StripeAPI.Operations.GetTaxRates

Methods

parseJSON :: Value -> Parser GetTaxRatesRequestBody

parseJSONList :: Value -> Parser [GetTaxRatesRequestBody]

data GetTaxRatesResponse

Represents a response of the operation getTaxRates.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), GetTaxRatesResponseError is used.

Constructors

GetTaxRatesResponseError String

Means either no matching case available or a parse error

GetTaxRatesResponse200 GetTaxRatesResponseBody200

Successful response.

GetTaxRatesResponseDefault Error

Error response.

Instances

Eq GetTaxRatesResponse

Defined in StripeAPI.Operations.GetTaxRates

Methods

(==) :: GetTaxRatesResponse -> GetTaxRatesResponse -> Bool

(/=) :: GetTaxRatesResponse -> GetTaxRatesResponse -> Bool

Show GetTaxRatesResponse

Defined in StripeAPI.Operations.GetTaxRates

Methods

showsPrec :: Int -> GetTaxRatesResponse -> ShowS

show :: GetTaxRatesResponse -> String

showList :: [GetTaxRatesResponse] -> ShowS

data GetTaxRatesResponseBody200

Defines the data type for the schema GetTaxRatesResponseBody200

Constructors

GetTaxRatesResponseBody200

Fields

• getTaxRatesResponseBody200Data :: [] TaxRate

  data

• getTaxRatesResponseBody200HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• getTaxRatesResponseBody200Object :: GetTaxRatesResponseBody200Object'

  object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

• getTaxRatesResponseBody200Url :: String

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000
  • Must match pattern '^/v1/tax_rates'

Instances

Eq GetTaxRatesResponseBody200

Defined in StripeAPI.Operations.GetTaxRates

Methods

(==) :: GetTaxRatesResponseBody200 -> GetTaxRatesResponseBody200 -> Bool

(/=) :: GetTaxRatesResponseBody200 -> GetTaxRatesResponseBody200 -> Bool

Show GetTaxRatesResponseBody200

Defined in StripeAPI.Operations.GetTaxRates

Methods

showsPrec :: Int -> GetTaxRatesResponseBody200 -> ShowS

show :: GetTaxRatesResponseBody200 -> String

showList :: [GetTaxRatesResponseBody200] -> ShowS

ToJSON GetTaxRatesResponseBody200

Defined in StripeAPI.Operations.GetTaxRates

Methods

toJSON :: GetTaxRatesResponseBody200 -> Value

toEncoding :: GetTaxRatesResponseBody200 -> Encoding

toJSONList :: [GetTaxRatesResponseBody200] -> Value

toEncodingList :: [GetTaxRatesResponseBody200] -> Encoding

FromJSON GetTaxRatesResponseBody200

Defined in StripeAPI.Operations.GetTaxRates

Methods

parseJSON :: Value -> Parser GetTaxRatesResponseBody200

parseJSONList :: Value -> Parser [GetTaxRatesResponseBody200]

data GetTaxRatesResponseBody200Object'

Defines the enum schema GetTaxRatesResponseBody200Object'

String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

Constructors

GetTaxRatesResponseBody200Object'EnumOther Value

GetTaxRatesResponseBody200Object'EnumTyped String

GetTaxRatesResponseBody200Object'EnumStringList

Instances

Eq GetTaxRatesResponseBody200Object'

Defined in StripeAPI.Operations.GetTaxRates

Methods

(==) :: GetTaxRatesResponseBody200Object' -> GetTaxRatesResponseBody200Object' -> Bool

(/=) :: GetTaxRatesResponseBody200Object' -> GetTaxRatesResponseBody200Object' -> Bool

Show GetTaxRatesResponseBody200Object'

Defined in StripeAPI.Operations.GetTaxRates

Methods

showsPrec :: Int -> GetTaxRatesResponseBody200Object' -> ShowS

show :: GetTaxRatesResponseBody200Object' -> String

showList :: [GetTaxRatesResponseBody200Object'] -> ShowS

ToJSON GetTaxRatesResponseBody200Object'

Defined in StripeAPI.Operations.GetTaxRates

Methods

toJSON :: GetTaxRatesResponseBody200Object' -> Value

toEncoding :: GetTaxRatesResponseBody200Object' -> Encoding

toJSONList :: [GetTaxRatesResponseBody200Object'] -> Value

toEncodingList :: [GetTaxRatesResponseBody200Object'] -> Encoding

FromJSON GetTaxRatesResponseBody200Object'

Defined in StripeAPI.Operations.GetTaxRates

Methods

parseJSON :: Value -> Parser GetTaxRatesResponseBody200Object'

parseJSONList :: Value -> Parser [GetTaxRatesResponseBody200Object']