Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostTaxRatesTaxRate

Description

Contains the different functions to run the operation postTaxRatesTaxRate

Synopsis

postTaxRatesTaxRate :: forall m. MonadHTTP m => Text -> Maybe PostTaxRatesTaxRateRequestBody -> ClientT m (Response PostTaxRatesTaxRateResponse)
data PostTaxRatesTaxRateRequestBody = PostTaxRatesTaxRateRequestBody {
}
mkPostTaxRatesTaxRateRequestBody :: PostTaxRatesTaxRateRequestBody
data PostTaxRatesTaxRateRequestBodyMetadata'Variants
- = PostTaxRatesTaxRateRequestBodyMetadata'EmptyString
- | PostTaxRatesTaxRateRequestBodyMetadata'Object Object
data PostTaxRatesTaxRateRequestBodyTaxType'
data PostTaxRatesTaxRateResponse

Documentation

postTaxRatesTaxRate Source #

Arguments

:: forall m. MonadHTTP m
=> Text	tax_rate \| Constraints: Maximum length of 5000
-> Maybe PostTaxRatesTaxRateRequestBody	The request body to send
-> ClientT m (Response PostTaxRatesTaxRateResponse)	Monadic computation which returns the result of the operation

POST /v1/tax_rates/{tax_rate}

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

data PostTaxRatesTaxRateRequestBody Source #

Defines the object schema located at paths./v1/tax_rates/{tax_rate}.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostTaxRatesTaxRateRequestBody

Fields

postTaxRatesTaxRateRequestBodyActive :: Maybe Bool
active: Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.
postTaxRatesTaxRateRequestBodyCountry :: Maybe Text
country: Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
Constraints:
- Maximum length of 5000
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. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
Constraints:
- Maximum length of 50
postTaxRatesTaxRateRequestBodyMetadata :: Maybe PostTaxRatesTaxRateRequestBodyMetadata'Variants
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`.
postTaxRatesTaxRateRequestBodyState :: Maybe Text
state: ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
Constraints:
- Maximum length of 2
postTaxRatesTaxRateRequestBodyTaxType :: Maybe PostTaxRatesTaxRateRequestBodyTaxType'
tax_type: The high-level tax type, such as `vat` or `sales_tax`.

Instances

Instances details

Eq PostTaxRatesTaxRateRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostTaxRatesTaxRate Methods (==) :: PostTaxRatesTaxRateRequestBody -> PostTaxRatesTaxRateRequestBody -> Bool # (/=) :: PostTaxRatesTaxRateRequestBody -> PostTaxRatesTaxRateRequestBody -> Bool #
Show PostTaxRatesTaxRateRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostTaxRatesTaxRate Methods showsPrec :: Int -> PostTaxRatesTaxRateRequestBody -> ShowS # show :: PostTaxRatesTaxRateRequestBody -> String # showList :: [PostTaxRatesTaxRateRequestBody] -> ShowS #
ToJSON PostTaxRatesTaxRateRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostTaxRatesTaxRate Methods toJSON :: PostTaxRatesTaxRateRequestBody -> Value # toEncoding :: PostTaxRatesTaxRateRequestBody -> Encoding # toJSONList :: [PostTaxRatesTaxRateRequestBody] -> Value # toEncodingList :: [PostTaxRatesTaxRateRequestBody] -> Encoding #
FromJSON PostTaxRatesTaxRateRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostTaxRatesTaxRate Methods parseJSON :: Value -> Parser PostTaxRatesTaxRateRequestBody # parseJSONList :: Value -> Parser [PostTaxRatesTaxRateRequestBody] #

mkPostTaxRatesTaxRateRequestBody :: PostTaxRatesTaxRateRequestBody Source #

Create a new PostTaxRatesTaxRateRequestBody with all required fields.

data PostTaxRatesTaxRateRequestBodyMetadata'Variants Source #

Defines the oneOf schema located at paths./v1/tax_rates/{tax_rate}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf in the specification.

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'EmptyString	Represents the JSON value `""`
PostTaxRatesTaxRateRequestBodyMetadata'Object Object

Instances

Instances details

Eq PostTaxRatesTaxRateRequestBodyMetadata'Variants Source #
Instance details Defined in StripeAPI.Operations.PostTaxRatesTaxRate Methods (==) :: PostTaxRatesTaxRateRequestBodyMetadata'Variants -> PostTaxRatesTaxRateRequestBodyMetadata'Variants -> Bool # (/=) :: PostTaxRatesTaxRateRequestBodyMetadata'Variants -> PostTaxRatesTaxRateRequestBodyMetadata'Variants -> Bool #
Show PostTaxRatesTaxRateRequestBodyMetadata'Variants Source #
Instance details Defined in StripeAPI.Operations.PostTaxRatesTaxRate Methods showsPrec :: Int -> PostTaxRatesTaxRateRequestBodyMetadata'Variants -> ShowS # show :: PostTaxRatesTaxRateRequestBodyMetadata'Variants -> String # showList :: [PostTaxRatesTaxRateRequestBodyMetadata'Variants] -> ShowS #
ToJSON PostTaxRatesTaxRateRequestBodyMetadata'Variants Source #
Instance details Defined in StripeAPI.Operations.PostTaxRatesTaxRate Methods toJSON :: PostTaxRatesTaxRateRequestBodyMetadata'Variants -> Value # toEncoding :: PostTaxRatesTaxRateRequestBodyMetadata'Variants -> Encoding # toJSONList :: [PostTaxRatesTaxRateRequestBodyMetadata'Variants] -> Value # toEncodingList :: [PostTaxRatesTaxRateRequestBodyMetadata'Variants] -> Encoding #
FromJSON PostTaxRatesTaxRateRequestBodyMetadata'Variants Source #
Instance details Defined in StripeAPI.Operations.PostTaxRatesTaxRate Methods parseJSON :: Value -> Parser PostTaxRatesTaxRateRequestBodyMetadata'Variants # parseJSONList :: Value -> Parser [PostTaxRatesTaxRateRequestBodyMetadata'Variants] #

data PostTaxRatesTaxRateRequestBodyTaxType' Source #

Defines the enum schema located at paths./v1/tax_rates/{tax_rate}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.tax_type in the specification.

The high-level tax type, such as `vat` or `sales_tax`.

Constructors

PostTaxRatesTaxRateRequestBodyTaxType'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostTaxRatesTaxRateRequestBodyTaxType'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
PostTaxRatesTaxRateRequestBodyTaxType'EnumGst	Represents the JSON value `"gst"`
PostTaxRatesTaxRateRequestBodyTaxType'EnumHst	Represents the JSON value `"hst"`
PostTaxRatesTaxRateRequestBodyTaxType'EnumPst	Represents the JSON value `"pst"`
PostTaxRatesTaxRateRequestBodyTaxType'EnumQst	Represents the JSON value `"qst"`
PostTaxRatesTaxRateRequestBodyTaxType'EnumSalesTax	Represents the JSON value `"sales_tax"`
PostTaxRatesTaxRateRequestBodyTaxType'EnumVat	Represents the JSON value `"vat"`

Instances

Instances details

Eq PostTaxRatesTaxRateRequestBodyTaxType' Source #
Instance details Defined in StripeAPI.Operations.PostTaxRatesTaxRate Methods (==) :: PostTaxRatesTaxRateRequestBodyTaxType' -> PostTaxRatesTaxRateRequestBodyTaxType' -> Bool # (/=) :: PostTaxRatesTaxRateRequestBodyTaxType' -> PostTaxRatesTaxRateRequestBodyTaxType' -> Bool #
Show PostTaxRatesTaxRateRequestBodyTaxType' Source #
Instance details Defined in StripeAPI.Operations.PostTaxRatesTaxRate Methods showsPrec :: Int -> PostTaxRatesTaxRateRequestBodyTaxType' -> ShowS # show :: PostTaxRatesTaxRateRequestBodyTaxType' -> String # showList :: [PostTaxRatesTaxRateRequestBodyTaxType'] -> ShowS #
ToJSON PostTaxRatesTaxRateRequestBodyTaxType' Source #
Instance details Defined in StripeAPI.Operations.PostTaxRatesTaxRate Methods toJSON :: PostTaxRatesTaxRateRequestBodyTaxType' -> Value # toEncoding :: PostTaxRatesTaxRateRequestBodyTaxType' -> Encoding # toJSONList :: [PostTaxRatesTaxRateRequestBodyTaxType'] -> Value # toEncodingList :: [PostTaxRatesTaxRateRequestBodyTaxType'] -> Encoding #
FromJSON PostTaxRatesTaxRateRequestBodyTaxType' Source #
Instance details Defined in StripeAPI.Operations.PostTaxRatesTaxRate Methods parseJSON :: Value -> Parser PostTaxRatesTaxRateRequestBodyTaxType' # parseJSONList :: Value -> Parser [PostTaxRatesTaxRateRequestBodyTaxType'] #

data PostTaxRatesTaxRateResponse Source #

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

Instances details

Eq PostTaxRatesTaxRateResponse Source #
Instance details Defined in StripeAPI.Operations.PostTaxRatesTaxRate Methods (==) :: PostTaxRatesTaxRateResponse -> PostTaxRatesTaxRateResponse -> Bool # (/=) :: PostTaxRatesTaxRateResponse -> PostTaxRatesTaxRateResponse -> Bool #
Show PostTaxRatesTaxRateResponse Source #
Instance details Defined in StripeAPI.Operations.PostTaxRatesTaxRate Methods showsPrec :: Int -> PostTaxRatesTaxRateResponse -> ShowS # show :: PostTaxRatesTaxRateResponse -> String # showList :: [PostTaxRatesTaxRateResponse] -> ShowS #