StripeAPI.Types.TaxRate

Contains the types generated from the schema TaxRate

Documentation

data TaxRate

Defines the data type for the schema tax_rate

Tax rates can be applied to invoices and subscriptions 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 applied to objects in the API, but will still be applied to subscriptions and invoices that already have it set.

• taxRateCreated :: Integer

  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.

  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 :: TaxRateMetadata'

  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.

• taxRateObject :: TaxRateObject'

  object: String representing the object's type. Objects of the same type share the same value.

• taxRatePercentage :: Double

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

Instances

Eq TaxRate

Defined in StripeAPI.Types.TaxRate

Methods

(==) :: TaxRate -> TaxRate -> Bool

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

Show TaxRate

Defined in StripeAPI.Types.TaxRate

Methods

showsPrec :: Int -> TaxRate -> ShowS

show :: TaxRate -> String

showList :: [TaxRate] -> ShowS

ToJSON TaxRate

Defined in StripeAPI.Types.TaxRate

Methods

toJSON :: TaxRate -> Value

toEncoding :: TaxRate -> Encoding

toJSONList :: [TaxRate] -> Value

toEncodingList :: [TaxRate] -> Encoding

FromJSON TaxRate

Defined in StripeAPI.Types.TaxRate

Methods

parseJSON :: Value -> Parser TaxRate

parseJSONList :: Value -> Parser [TaxRate]

data TaxRateMetadata'

Defines the data type for the schema tax_rateMetadata'

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.

Constructors

TaxRateMetadata'

Instances

Eq TaxRateMetadata'

Defined in StripeAPI.Types.TaxRate

Methods

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

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

Show TaxRateMetadata'

Defined in StripeAPI.Types.TaxRate

Methods

showsPrec :: Int -> TaxRateMetadata' -> ShowS

show :: TaxRateMetadata' -> String

showList :: [TaxRateMetadata'] -> ShowS

ToJSON TaxRateMetadata'

Defined in StripeAPI.Types.TaxRate

Methods

toJSON :: TaxRateMetadata' -> Value

toEncoding :: TaxRateMetadata' -> Encoding

toJSONList :: [TaxRateMetadata'] -> Value

toEncodingList :: [TaxRateMetadata'] -> Encoding

FromJSON TaxRateMetadata'

Defined in StripeAPI.Types.TaxRate

Methods

parseJSON :: Value -> Parser TaxRateMetadata'

parseJSONList :: Value -> Parser [TaxRateMetadata']

data TaxRateObject'

Defines the enum schema tax_rateObject'

String representing the object's type. Objects of the same type share the same value.

Constructors

TaxRateObject'EnumOther Value

TaxRateObject'EnumTyped Text

TaxRateObject'EnumStringTaxRate

Instances

Eq TaxRateObject'

Defined in StripeAPI.Types.TaxRate

Methods

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

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

Show TaxRateObject'

Defined in StripeAPI.Types.TaxRate

Methods

showsPrec :: Int -> TaxRateObject' -> ShowS

show :: TaxRateObject' -> String

showList :: [TaxRateObject'] -> ShowS

ToJSON TaxRateObject'

Defined in StripeAPI.Types.TaxRate

Methods

toJSON :: TaxRateObject' -> Value

toEncoding :: TaxRateObject' -> Encoding

toJSONList :: [TaxRateObject'] -> Value

toEncodingList :: [TaxRateObject'] -> Encoding

FromJSON TaxRateObject'

Defined in StripeAPI.Types.TaxRate

Methods

parseJSON :: Value -> Parser TaxRateObject'

parseJSONList :: Value -> Parser [TaxRateObject']