stripeapi-2.0.0.1: Stripe-Library
Safe HaskellNone
LanguageHaskell2010

StripeAPI.Types.TaxId

Description

Contains the types generated from the schema TaxId

Synopsis

Documentation

data TaxId Source #

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

You can add one or multiple tax IDs to a customer. A customer's tax IDs are displayed on invoices and credit notes issued for the customer.

Related guide: Customer Tax Identification Numbers.

Constructors

TaxId 

Fields

  • taxIdCountry :: Maybe Text

    country: Two-letter ISO code representing the country of the tax ID.

    Constraints:

    • Maximum length of 5000
  • taxIdCreated :: Int

    created: Time at which the object was created. Measured in seconds since the Unix epoch.

  • taxIdCustomer :: Maybe TaxIdCustomer'Variants

    customer: ID of the customer.

  • taxIdId :: Text

    id: Unique identifier for the object.

    Constraints:

    • Maximum length of 5000
  • taxIdLivemode :: Bool

    livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

  • taxIdType :: TaxIdType'

    type: Type of the tax ID, one of `ae_trn`, `au_abn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `us_ein`, or `za_vat`. Note that some legacy tax IDs have type `unknown`

  • taxIdValue :: Text

    value: Value of the tax ID.

    Constraints:

    • Maximum length of 5000
  • taxIdVerification :: Maybe TaxIdVerification'

    verification: Tax ID verification information.

Instances

Instances details
Eq TaxId Source # 
Instance details

Defined in StripeAPI.Types.TaxId

Methods

(==) :: TaxId -> TaxId -> Bool #

(/=) :: TaxId -> TaxId -> Bool #

Show TaxId Source # 
Instance details

Defined in StripeAPI.Types.TaxId

Methods

showsPrec :: Int -> TaxId -> ShowS #

show :: TaxId -> String #

showList :: [TaxId] -> ShowS #

ToJSON TaxId Source # 
Instance details

Defined in StripeAPI.Types.TaxId

FromJSON TaxId Source # 
Instance details

Defined in StripeAPI.Types.TaxId

mkTaxId Source #

Create a new TaxId with all required fields.

data TaxIdType' Source #

Defines the enum schema located at components.schemas.tax_id.properties.type in the specification.

Type of the tax ID, one of `ae_trn`, `au_abn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `us_ein`, or `za_vat`. Note that some legacy tax IDs have type `unknown`

Constructors

TaxIdType'Other Value

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

TaxIdType'Typed Text

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

TaxIdType'EnumAeTrn

Represents the JSON value "ae_trn"

TaxIdType'EnumAuAbn

Represents the JSON value "au_abn"

TaxIdType'EnumBrCnpj

Represents the JSON value "br_cnpj"

TaxIdType'EnumBrCpf

Represents the JSON value "br_cpf"

TaxIdType'EnumCaBn

Represents the JSON value "ca_bn"

TaxIdType'EnumCaGstHst

Represents the JSON value "ca_gst_hst"

TaxIdType'EnumCaPstBc

Represents the JSON value "ca_pst_bc"

TaxIdType'EnumCaPstMb

Represents the JSON value "ca_pst_mb"

TaxIdType'EnumCaPstSk

Represents the JSON value "ca_pst_sk"

TaxIdType'EnumCaQst

Represents the JSON value "ca_qst"

TaxIdType'EnumChVat

Represents the JSON value "ch_vat"

TaxIdType'EnumClTin

Represents the JSON value "cl_tin"

TaxIdType'EnumEsCif

Represents the JSON value "es_cif"

TaxIdType'EnumEuVat

Represents the JSON value "eu_vat"

TaxIdType'EnumGbVat

Represents the JSON value "gb_vat"

TaxIdType'EnumHkBr

Represents the JSON value "hk_br"

TaxIdType'EnumIdNpwp

Represents the JSON value "id_npwp"

TaxIdType'EnumIlVat

Represents the JSON value "il_vat"

TaxIdType'EnumInGst

Represents the JSON value "in_gst"

TaxIdType'EnumJpCn

Represents the JSON value "jp_cn"

TaxIdType'EnumJpRn

Represents the JSON value "jp_rn"

TaxIdType'EnumKrBrn

Represents the JSON value "kr_brn"

TaxIdType'EnumLiUid

Represents the JSON value "li_uid"

TaxIdType'EnumMxRfc

Represents the JSON value "mx_rfc"

TaxIdType'EnumMyFrp

Represents the JSON value "my_frp"

TaxIdType'EnumMyItn

Represents the JSON value "my_itn"

TaxIdType'EnumMySst

Represents the JSON value "my_sst"

TaxIdType'EnumNoVat

Represents the JSON value "no_vat"

TaxIdType'EnumNzGst

Represents the JSON value "nz_gst"

TaxIdType'EnumRuInn

Represents the JSON value "ru_inn"

TaxIdType'EnumRuKpp

Represents the JSON value "ru_kpp"

TaxIdType'EnumSaVat

Represents the JSON value "sa_vat"

TaxIdType'EnumSgGst

Represents the JSON value "sg_gst"

TaxIdType'EnumSgUen

Represents the JSON value "sg_uen"

TaxIdType'EnumThVat

Represents the JSON value "th_vat"

TaxIdType'EnumTwVat

Represents the JSON value "tw_vat"

TaxIdType'EnumUnknown

Represents the JSON value "unknown"

TaxIdType'EnumUsEin

Represents the JSON value "us_ein"

TaxIdType'EnumZaVat

Represents the JSON value "za_vat"

data TaxIdVerification' Source #

Defines the object schema located at components.schemas.tax_id.properties.verification.anyOf in the specification.

Tax ID verification information.

Constructors

TaxIdVerification' 

Fields

mkTaxIdVerification' :: TaxIdVerification' Source #

Create a new TaxIdVerification' with all required fields.

data TaxIdVerification'Status' Source #

Defines the enum schema located at components.schemas.tax_id.properties.verification.anyOf.properties.status in the specification.

Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`.

Constructors

TaxIdVerification'Status'Other Value

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

TaxIdVerification'Status'Typed Text

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

TaxIdVerification'Status'EnumPending

Represents the JSON value "pending"

TaxIdVerification'Status'EnumUnavailable

Represents the JSON value "unavailable"

TaxIdVerification'Status'EnumUnverified

Represents the JSON value "unverified"

TaxIdVerification'Status'EnumVerified

Represents the JSON value "verified"