Safe Haskell	None
Language	Haskell2010

StripeAPI.Types.TaxRate

Description

Contains the types generated from the schema TaxRate

Synopsis

data TaxRate = TaxRate {
- taxRateActive :: Bool
- taxRateCountry :: Maybe Text
- taxRateCreated :: Int
- taxRateDescription :: Maybe Text
- taxRateDisplayName :: Text
- taxRateId :: Text
- taxRateInclusive :: Bool
- taxRateJurisdiction :: Maybe Text
- taxRateLivemode :: Bool
- taxRateMetadata :: Maybe Object
- taxRatePercentage :: Double
- taxRateState :: Maybe Text
- taxRateTaxType :: Maybe TaxRateTaxType'
}
mkTaxRate :: Bool -> Int -> Text -> Text -> Bool -> Bool -> Double -> TaxRate
data TaxRateTaxType'

Documentation

data TaxRate Source #

Defines the object schema located at components.schemas.tax_rate in the specification.

Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.

Related guide: Tax Rates.

Constructors

TaxRate

Fields

taxRateActive :: Bool
active: Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.
taxRateCountry :: 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
taxRateCreated :: Int
created: Time at which the object was created. Measured in seconds since the Unix epoch.
taxRateDescription :: 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
taxRateDisplayName :: Text
display_name: The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
Constraints:
- Maximum length of 5000
taxRateId :: Text
id: Unique identifier for the object.
Constraints:
- Maximum length of 5000
taxRateInclusive :: Bool
inclusive: This specifies if the tax rate is inclusive or exclusive.
taxRateJurisdiction :: 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 5000
taxRateLivemode :: Bool
livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
taxRateMetadata :: 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.
taxRatePercentage :: Double
percentage: This represents the tax rate percent out of 100.
taxRateState :: Maybe Text
state: ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
Constraints:
- Maximum length of 5000
taxRateTaxType :: Maybe TaxRateTaxType'
tax_type: The high-level tax type, such as `vat` or `sales_tax`.

Instances

Instances details

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

mkTaxRate Source #

Arguments

:: Bool	`taxRateActive`
-> Int	`taxRateCreated`
-> Text	`taxRateDisplayName`
-> Text	`taxRateId`
-> Bool	`taxRateInclusive`
-> Bool	`taxRateLivemode`
-> Double	`taxRatePercentage`
-> TaxRate

Create a new TaxRate with all required fields.

data TaxRateTaxType' Source #

Defines the enum schema located at components.schemas.tax_rate.properties.tax_type in the specification.

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

Constructors

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

Instances

Instances details

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