StripeAPI.Operations.GetTaxRates

Contains the different functions to run the operation getTaxRates

Documentation

getTaxRates

Arguments

:: forall m. MonadHTTP m

=> GetTaxRatesParameters

Contains all available parameters of this operation (query and path parameters)

-> ClientT m (Response GetTaxRatesResponse)

Monadic computation which returns 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>

data GetTaxRatesParameters

Defines the object schema located at paths./v1/tax_rates.GET.parameters in the specification.

Constructors

GetTaxRatesParameters

Fields

• getTaxRatesParametersQueryActive :: Maybe Bool

  queryActive: Represents the parameter named 'active'

  Optional flag to filter by tax rates that are either active or inactive (archived).

• getTaxRatesParametersQueryCreated :: Maybe GetTaxRatesParametersQueryCreated'Variants

  queryCreated: Represents the parameter named 'created'

  Optional range for filtering created date.

• getTaxRatesParametersQueryEndingBefore :: Maybe Text

  queryEnding_before: Represents the parameter named '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
• getTaxRatesParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

• getTaxRatesParametersQueryInclusive :: Maybe Bool

  queryInclusive: Represents the parameter named 'inclusive'

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

• getTaxRatesParametersQueryLimit :: Maybe Int

  queryLimit: Represents the parameter named 'limit'

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

• getTaxRatesParametersQueryStartingAfter :: Maybe Text

  queryStarting_after: Represents the parameter named '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

Instances

Eq GetTaxRatesParameters

Defined in StripeAPI.Operations.GetTaxRates

Methods

(==) :: GetTaxRatesParameters -> GetTaxRatesParameters -> Bool

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

Show GetTaxRatesParameters

Defined in StripeAPI.Operations.GetTaxRates

Methods

showsPrec :: Int -> GetTaxRatesParameters -> ShowS

show :: GetTaxRatesParameters -> String

showList :: [GetTaxRatesParameters] -> ShowS

ToJSON GetTaxRatesParameters

Defined in StripeAPI.Operations.GetTaxRates

Methods

toJSON :: GetTaxRatesParameters -> Value

toEncoding :: GetTaxRatesParameters -> Encoding

toJSONList :: [GetTaxRatesParameters] -> Value

toEncodingList :: [GetTaxRatesParameters] -> Encoding

FromJSON GetTaxRatesParameters

Defined in StripeAPI.Operations.GetTaxRates

Methods

parseJSON :: Value -> Parser GetTaxRatesParameters

parseJSONList :: Value -> Parser [GetTaxRatesParameters]

mkGetTaxRatesParameters :: GetTaxRatesParameters

Create a new GetTaxRatesParameters with all required fields.

data GetTaxRatesParametersQueryCreated'OneOf1

Defines the object schema located at paths./v1/tax_rates.GET.parameters.properties.queryCreated.anyOf in the specification.

Constructors

GetTaxRatesParametersQueryCreated'OneOf1

Fields

• getTaxRatesParametersQueryCreated'OneOf1Gt :: Maybe Int

  gt

• getTaxRatesParametersQueryCreated'OneOf1Gte :: Maybe Int

  gte

• getTaxRatesParametersQueryCreated'OneOf1Lt :: Maybe Int

  lt

• getTaxRatesParametersQueryCreated'OneOf1Lte :: Maybe Int

  lte

Instances

Eq GetTaxRatesParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetTaxRates

Methods

(==) :: GetTaxRatesParametersQueryCreated'OneOf1 -> GetTaxRatesParametersQueryCreated'OneOf1 -> Bool

(/=) :: GetTaxRatesParametersQueryCreated'OneOf1 -> GetTaxRatesParametersQueryCreated'OneOf1 -> Bool

Show GetTaxRatesParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetTaxRates

Methods

showsPrec :: Int -> GetTaxRatesParametersQueryCreated'OneOf1 -> ShowS

show :: GetTaxRatesParametersQueryCreated'OneOf1 -> String

showList :: [GetTaxRatesParametersQueryCreated'OneOf1] -> ShowS

ToJSON GetTaxRatesParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetTaxRates

Methods

toJSON :: GetTaxRatesParametersQueryCreated'OneOf1 -> Value

toEncoding :: GetTaxRatesParametersQueryCreated'OneOf1 -> Encoding

toJSONList :: [GetTaxRatesParametersQueryCreated'OneOf1] -> Value

toEncodingList :: [GetTaxRatesParametersQueryCreated'OneOf1] -> Encoding

FromJSON GetTaxRatesParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetTaxRates

Methods

parseJSON :: Value -> Parser GetTaxRatesParametersQueryCreated'OneOf1

parseJSONList :: Value -> Parser [GetTaxRatesParametersQueryCreated'OneOf1]

mkGetTaxRatesParametersQueryCreated'OneOf1 :: GetTaxRatesParametersQueryCreated'OneOf1

Create a new GetTaxRatesParametersQueryCreated'OneOf1 with all required fields.

data GetTaxRatesParametersQueryCreated'Variants

Defines the oneOf schema located at paths./v1/tax_rates.GET.parameters.properties.queryCreated.anyOf in the specification.

Represents the parameter named 'created'

Optional range for filtering created date.

Constructors

GetTaxRatesParametersQueryCreated'GetTaxRatesParametersQueryCreated'OneOf1 GetTaxRatesParametersQueryCreated'OneOf1

GetTaxRatesParametersQueryCreated'Int Int

Instances

Eq GetTaxRatesParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetTaxRates

Methods

(==) :: GetTaxRatesParametersQueryCreated'Variants -> GetTaxRatesParametersQueryCreated'Variants -> Bool

(/=) :: GetTaxRatesParametersQueryCreated'Variants -> GetTaxRatesParametersQueryCreated'Variants -> Bool

Show GetTaxRatesParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetTaxRates

Methods

showsPrec :: Int -> GetTaxRatesParametersQueryCreated'Variants -> ShowS

show :: GetTaxRatesParametersQueryCreated'Variants -> String

showList :: [GetTaxRatesParametersQueryCreated'Variants] -> ShowS

ToJSON GetTaxRatesParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetTaxRates

Methods

toJSON :: GetTaxRatesParametersQueryCreated'Variants -> Value

toEncoding :: GetTaxRatesParametersQueryCreated'Variants -> Encoding

toJSONList :: [GetTaxRatesParametersQueryCreated'Variants] -> Value

toEncodingList :: [GetTaxRatesParametersQueryCreated'Variants] -> Encoding

FromJSON GetTaxRatesParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetTaxRates

Methods

parseJSON :: Value -> Parser GetTaxRatesParametersQueryCreated'Variants

parseJSONList :: Value -> Parser [GetTaxRatesParametersQueryCreated'Variants]

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 object schema located at paths./v1/tax_rates.GET.responses.200.content.application/json.schema in the specification.

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.

• getTaxRatesResponseBody200Url :: Text

  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]

mkGetTaxRatesResponseBody200

Arguments

:: [TaxRate]

getTaxRatesResponseBody200Data

-> Bool

getTaxRatesResponseBody200HasMore

-> Text

getTaxRatesResponseBody200Url

-> GetTaxRatesResponseBody200

Create a new GetTaxRatesResponseBody200 with all required fields.