stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Types.TaxRate

Description

Contains the types generated from the schema TaxRate

Synopsis

Documentation

data TaxRate Source #

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 String

    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 :: String

    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 :: String

    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 String

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

ToJSON TaxRate Source # 
Instance details

Defined in StripeAPI.Types.TaxRate

FromJSON TaxRate Source # 
Instance details

Defined in StripeAPI.Types.TaxRate

data TaxRateMetadata' Source #

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' 

data TaxRateObject' Source #

Defines the enum schema tax_rateObject'

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