stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetTaxRates

Description

Contains the different functions to run the operation getTaxRates

Synopsis

Documentation

getTaxRates Source #

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>

data GetTaxRatesResponse Source #

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.

data GetTaxRatesResponseBody200 Source #

Defines the data type for the schema GetTaxRatesResponseBody200

Constructors

GetTaxRatesResponseBody200 

Fields

data GetTaxRatesResponseBody200Object' Source #

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`.