StripeAPI.Operations.PostTaxRatesTaxRate

Contains the different functions to run the operation postTaxRatesTaxRate

Documentation

postTaxRatesTaxRate

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Text

tax_rate | Constraints: Maximum length of 5000

-> Maybe PostTaxRatesTaxRateRequestBody

The request body to send

-> m (Either HttpException (Response PostTaxRatesTaxRateResponse))

Monad containing the result of the operation

POST /v1/tax_rates/{tax_rate}

<p>Updates an existing tax rate.</p>

postTaxRatesTaxRateRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostTaxRatesTaxRateRequestBody -> m (Either HttpException (Response ByteString))

POST /v1/tax_rates/{tax_rate}

The same as postTaxRatesTaxRate but returns the raw ByteString

postTaxRatesTaxRateM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostTaxRatesTaxRateRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostTaxRatesTaxRateResponse))

POST /v1/tax_rates/{tax_rate}

Monadic version of postTaxRatesTaxRate (use with runWithConfiguration)

postTaxRatesTaxRateRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostTaxRatesTaxRateRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

POST /v1/tax_rates/{tax_rate}

Monadic version of postTaxRatesTaxRateRaw (use with runWithConfiguration)

data PostTaxRatesTaxRateRequestBody

Defines the data type for the schema postTaxRatesTaxRateRequestBody

Constructors

PostTaxRatesTaxRateRequestBody

Fields

• postTaxRatesTaxRateRequestBodyActive :: 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.

• postTaxRatesTaxRateRequestBodyDescription :: 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
• postTaxRatesTaxRateRequestBodyDisplayName :: Maybe Text

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

  Constraints:

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

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

• postTaxRatesTaxRateRequestBodyJurisdiction :: Maybe Text

  jurisdiction: The jurisdiction for the tax rate.

  Constraints:

  • Maximum length of 50
• postTaxRatesTaxRateRequestBodyMetadata :: Maybe PostTaxRatesTaxRateRequestBodyMetadata'

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

Instances

Eq PostTaxRatesTaxRateRequestBody

Defined in StripeAPI.Operations.PostTaxRatesTaxRate

Methods

(==) :: PostTaxRatesTaxRateRequestBody -> PostTaxRatesTaxRateRequestBody -> Bool

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

Show PostTaxRatesTaxRateRequestBody

Defined in StripeAPI.Operations.PostTaxRatesTaxRate

Methods

showsPrec :: Int -> PostTaxRatesTaxRateRequestBody -> ShowS

show :: PostTaxRatesTaxRateRequestBody -> String

showList :: [PostTaxRatesTaxRateRequestBody] -> ShowS

ToJSON PostTaxRatesTaxRateRequestBody

Defined in StripeAPI.Operations.PostTaxRatesTaxRate

Methods

toJSON :: PostTaxRatesTaxRateRequestBody -> Value

toEncoding :: PostTaxRatesTaxRateRequestBody -> Encoding

toJSONList :: [PostTaxRatesTaxRateRequestBody] -> Value

toEncodingList :: [PostTaxRatesTaxRateRequestBody] -> Encoding

FromJSON PostTaxRatesTaxRateRequestBody

Defined in StripeAPI.Operations.PostTaxRatesTaxRate

Methods

parseJSON :: Value -> Parser PostTaxRatesTaxRateRequestBody

parseJSONList :: Value -> Parser [PostTaxRatesTaxRateRequestBody]

data PostTaxRatesTaxRateRequestBodyMetadata'

Defines the data type for the schema postTaxRatesTaxRateRequestBodyMetadata'

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

PostTaxRatesTaxRateRequestBodyMetadata'

Instances

Eq PostTaxRatesTaxRateRequestBodyMetadata'

Defined in StripeAPI.Operations.PostTaxRatesTaxRate

Methods

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

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

Show PostTaxRatesTaxRateRequestBodyMetadata'

Defined in StripeAPI.Operations.PostTaxRatesTaxRate

Methods

showsPrec :: Int -> PostTaxRatesTaxRateRequestBodyMetadata' -> ShowS

show :: PostTaxRatesTaxRateRequestBodyMetadata' -> String

showList :: [PostTaxRatesTaxRateRequestBodyMetadata'] -> ShowS

ToJSON PostTaxRatesTaxRateRequestBodyMetadata'

Defined in StripeAPI.Operations.PostTaxRatesTaxRate

Methods

toJSON :: PostTaxRatesTaxRateRequestBodyMetadata' -> Value

toEncoding :: PostTaxRatesTaxRateRequestBodyMetadata' -> Encoding

toJSONList :: [PostTaxRatesTaxRateRequestBodyMetadata'] -> Value

toEncodingList :: [PostTaxRatesTaxRateRequestBodyMetadata'] -> Encoding

FromJSON PostTaxRatesTaxRateRequestBodyMetadata'

Defined in StripeAPI.Operations.PostTaxRatesTaxRate

Methods

parseJSON :: Value -> Parser PostTaxRatesTaxRateRequestBodyMetadata'

parseJSONList :: Value -> Parser [PostTaxRatesTaxRateRequestBodyMetadata']

data PostTaxRatesTaxRateResponse

Represents a response of the operation postTaxRatesTaxRate.

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

Constructors

PostTaxRatesTaxRateResponseError String

Means either no matching case available or a parse error

PostTaxRatesTaxRateResponse200 TaxRate

Successful response.

PostTaxRatesTaxRateResponseDefault Error

Error response.

Instances

Eq PostTaxRatesTaxRateResponse

Defined in StripeAPI.Operations.PostTaxRatesTaxRate

Methods

(==) :: PostTaxRatesTaxRateResponse -> PostTaxRatesTaxRateResponse -> Bool

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

Show PostTaxRatesTaxRateResponse

Defined in StripeAPI.Operations.PostTaxRatesTaxRate

Methods

showsPrec :: Int -> PostTaxRatesTaxRateResponse -> ShowS

show :: PostTaxRatesTaxRateResponse -> String

showList :: [PostTaxRatesTaxRateResponse] -> ShowS