StripeAPI.Operations.PostTaxRates

Contains the different functions to run the operation postTaxRates

Documentation

postTaxRates

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> PostTaxRatesRequestBody

The request body to send

-> m (Either HttpException (Response PostTaxRatesResponse))

Monad containing the result of the operation

POST /v1/tax_rates

<p>Creates a new tax rate.</p>

postTaxRatesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostTaxRatesRequestBody -> m (Either HttpException (Response ByteString))

POST /v1/tax_rates

The same as postTaxRates but returns the raw ByteString

postTaxRatesM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostTaxRatesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostTaxRatesResponse))

POST /v1/tax_rates

Monadic version of postTaxRates (use with runWithConfiguration)

postTaxRatesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostTaxRatesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

POST /v1/tax_rates

Monadic version of postTaxRatesRaw (use with runWithConfiguration)

data PostTaxRatesRequestBody

Defines the data type for the schema postTaxRatesRequestBody

Constructors

PostTaxRatesRequestBody

Fields

• postTaxRatesRequestBodyActive :: Maybe Bool

  active: Flag determining whether the tax rate is active or inactive. Inactive tax rates continue to work where they are currently applied however they cannot be used for new applications.

• postTaxRatesRequestBodyDescription :: Maybe Text

  description: An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

  Constraints:

  • Maximum length of 5000
• postTaxRatesRequestBodyDisplayName :: Text

  display_name: The display name of the tax rate, which will be shown to users.

  Constraints:

  • Maximum length of 50
• postTaxRatesRequestBodyExpand :: Maybe ([] Text)

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

• postTaxRatesRequestBodyInclusive :: Bool

  inclusive: This specifies if the tax rate is inclusive or exclusive.

• postTaxRatesRequestBodyJurisdiction :: Maybe Text

  jurisdiction: The jurisdiction for the tax rate.

  Constraints:

  • Maximum length of 50
• postTaxRatesRequestBodyMetadata :: Maybe PostTaxRatesRequestBodyMetadata'

  metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

• postTaxRatesRequestBodyPercentage :: Double

  percentage: This represents the tax rate percent out of 100.

Instances

Eq PostTaxRatesRequestBody

Defined in StripeAPI.Operations.PostTaxRates

Methods

(==) :: PostTaxRatesRequestBody -> PostTaxRatesRequestBody -> Bool

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

Show PostTaxRatesRequestBody

Defined in StripeAPI.Operations.PostTaxRates

Methods

showsPrec :: Int -> PostTaxRatesRequestBody -> ShowS

show :: PostTaxRatesRequestBody -> String

showList :: [PostTaxRatesRequestBody] -> ShowS

ToJSON PostTaxRatesRequestBody

Defined in StripeAPI.Operations.PostTaxRates

Methods

toJSON :: PostTaxRatesRequestBody -> Value

toEncoding :: PostTaxRatesRequestBody -> Encoding

toJSONList :: [PostTaxRatesRequestBody] -> Value

toEncodingList :: [PostTaxRatesRequestBody] -> Encoding

FromJSON PostTaxRatesRequestBody

Defined in StripeAPI.Operations.PostTaxRates

Methods

parseJSON :: Value -> Parser PostTaxRatesRequestBody

parseJSONList :: Value -> Parser [PostTaxRatesRequestBody]

data PostTaxRatesRequestBodyMetadata'

Defines the data type for the schema postTaxRatesRequestBodyMetadata'

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

Constructors

PostTaxRatesRequestBodyMetadata'

Instances

Eq PostTaxRatesRequestBodyMetadata'

Defined in StripeAPI.Operations.PostTaxRates

Methods

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

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

Show PostTaxRatesRequestBodyMetadata'

Defined in StripeAPI.Operations.PostTaxRates

Methods

showsPrec :: Int -> PostTaxRatesRequestBodyMetadata' -> ShowS

show :: PostTaxRatesRequestBodyMetadata' -> String

showList :: [PostTaxRatesRequestBodyMetadata'] -> ShowS

ToJSON PostTaxRatesRequestBodyMetadata'

Defined in StripeAPI.Operations.PostTaxRates

Methods

toJSON :: PostTaxRatesRequestBodyMetadata' -> Value

toEncoding :: PostTaxRatesRequestBodyMetadata' -> Encoding

toJSONList :: [PostTaxRatesRequestBodyMetadata'] -> Value

toEncodingList :: [PostTaxRatesRequestBodyMetadata'] -> Encoding

FromJSON PostTaxRatesRequestBodyMetadata'

Defined in StripeAPI.Operations.PostTaxRates

Methods

parseJSON :: Value -> Parser PostTaxRatesRequestBodyMetadata'

parseJSONList :: Value -> Parser [PostTaxRatesRequestBodyMetadata']

data PostTaxRatesResponse

Represents a response of the operation postTaxRates.

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), PostTaxRatesResponseError is used.

Constructors

PostTaxRatesResponseError String

Means either no matching case available or a parse error

PostTaxRatesResponse200 TaxRate

Successful response.

PostTaxRatesResponseDefault Error

Error response.

Instances

Eq PostTaxRatesResponse

Defined in StripeAPI.Operations.PostTaxRates

Methods

(==) :: PostTaxRatesResponse -> PostTaxRatesResponse -> Bool

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

Show PostTaxRatesResponse

Defined in StripeAPI.Operations.PostTaxRates

Methods

showsPrec :: Int -> PostTaxRatesResponse -> ShowS

show :: PostTaxRatesResponse -> String

showList :: [PostTaxRatesResponse] -> ShowS