StripeAPI.Operations.PostTaxRates

Contains the different functions to run the operation postTaxRates

Documentation

postTaxRates

Arguments

:: forall m. MonadHTTP m

=> PostTaxRatesRequestBody

The request body to send

-> StripeT m (Response PostTaxRatesResponse)

Monadic computation which returns the result of the operation

POST /v1/tax_rates

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

data PostTaxRatesRequestBody

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

Constructors

PostTaxRatesRequestBody

Fields

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

• postTaxRatesRequestBodyCountry :: 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
• 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. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.

  Constraints:

  • Maximum length of 50
• postTaxRatesRequestBodyMetadata :: Maybe Object

  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.

• postTaxRatesRequestBodyState :: Maybe Text

  state: ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.

  Constraints:

  • Maximum length of 2
• postTaxRatesRequestBodyTaxType :: Maybe PostTaxRatesRequestBodyTaxType'

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

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]

mkPostTaxRatesRequestBody

Arguments

:: Text

postTaxRatesRequestBodyDisplayName

-> Bool

postTaxRatesRequestBodyInclusive

-> Double

postTaxRatesRequestBodyPercentage

-> PostTaxRatesRequestBody

Create a new PostTaxRatesRequestBody with all required fields.

data PostTaxRatesRequestBodyTaxType'

Defines the enum schema located at paths./v1/tax_rates.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

PostTaxRatesRequestBodyTaxType'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PostTaxRatesRequestBodyTaxType'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PostTaxRatesRequestBodyTaxType'EnumGst

Represents the JSON value "gst"

PostTaxRatesRequestBodyTaxType'EnumHst

Represents the JSON value "hst"

PostTaxRatesRequestBodyTaxType'EnumPst

Represents the JSON value "pst"

PostTaxRatesRequestBodyTaxType'EnumQst

Represents the JSON value "qst"

PostTaxRatesRequestBodyTaxType'EnumSalesTax

Represents the JSON value "sales_tax"

PostTaxRatesRequestBodyTaxType'EnumVat

Represents the JSON value "vat"

Instances

Eq PostTaxRatesRequestBodyTaxType'

Defined in StripeAPI.Operations.PostTaxRates

Methods

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

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

Show PostTaxRatesRequestBodyTaxType'

Defined in StripeAPI.Operations.PostTaxRates

Methods

showsPrec :: Int -> PostTaxRatesRequestBodyTaxType' -> ShowS

show :: PostTaxRatesRequestBodyTaxType' -> String

showList :: [PostTaxRatesRequestBodyTaxType'] -> ShowS

ToJSON PostTaxRatesRequestBodyTaxType'

Defined in StripeAPI.Operations.PostTaxRates

Methods

toJSON :: PostTaxRatesRequestBodyTaxType' -> Value

toEncoding :: PostTaxRatesRequestBodyTaxType' -> Encoding

toJSONList :: [PostTaxRatesRequestBodyTaxType'] -> Value

toEncodingList :: [PostTaxRatesRequestBodyTaxType'] -> Encoding

FromJSON PostTaxRatesRequestBodyTaxType'

Defined in StripeAPI.Operations.PostTaxRates

Methods

parseJSON :: Value -> Parser PostTaxRatesRequestBodyTaxType'

parseJSONList :: Value -> Parser [PostTaxRatesRequestBodyTaxType']

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