StripeAPI.Types.TaxId

Contains the types generated from the schema TaxId

Documentation

data TaxId

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

Eq TaxId

Defined in StripeAPI.Types.TaxId

Methods

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

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

Show TaxId

Defined in StripeAPI.Types.TaxId

Methods

showsPrec :: Int -> TaxId -> ShowS

show :: TaxId -> String

showList :: [TaxId] -> ShowS

ToJSON TaxId

Defined in StripeAPI.Types.TaxId

Methods

toJSON :: TaxId -> Value

toEncoding :: TaxId -> Encoding

toJSONList :: [TaxId] -> Value

toEncodingList :: [TaxId] -> Encoding

FromJSON TaxId

Defined in StripeAPI.Types.TaxId

Methods

parseJSON :: Value -> Parser TaxId

parseJSONList :: Value -> Parser [TaxId]

mkTaxId

Arguments

:: Int

taxIdCreated

-> Text

taxIdId

-> Bool

taxIdLivemode

-> TaxIdType'

taxIdType

-> Text

taxIdValue

-> TaxId

Create a new TaxId with all required fields.

data TaxIdCustomer'Variants

Defines the oneOf schema located at components.schemas.tax_id.properties.customer.anyOf in the specification.

ID of the customer.

Constructors

TaxIdCustomer'Text Text

TaxIdCustomer'Customer Customer

Instances

Eq TaxIdCustomer'Variants

Defined in StripeAPI.Types.TaxId

Methods

(==) :: TaxIdCustomer'Variants -> TaxIdCustomer'Variants -> Bool

(/=) :: TaxIdCustomer'Variants -> TaxIdCustomer'Variants -> Bool

Show TaxIdCustomer'Variants

Defined in StripeAPI.Types.TaxId

Methods

showsPrec :: Int -> TaxIdCustomer'Variants -> ShowS

show :: TaxIdCustomer'Variants -> String

showList :: [TaxIdCustomer'Variants] -> ShowS

ToJSON TaxIdCustomer'Variants

Defined in StripeAPI.Types.TaxId

Methods

toJSON :: TaxIdCustomer'Variants -> Value

toEncoding :: TaxIdCustomer'Variants -> Encoding

toJSONList :: [TaxIdCustomer'Variants] -> Value

toEncodingList :: [TaxIdCustomer'Variants] -> Encoding

FromJSON TaxIdCustomer'Variants

Defined in StripeAPI.Types.TaxId

Methods

parseJSON :: Value -> Parser TaxIdCustomer'Variants

parseJSONList :: Value -> Parser [TaxIdCustomer'Variants]

data TaxIdType'

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"

Instances

Eq TaxIdType'

Defined in StripeAPI.Types.TaxId

Methods

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

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

Show TaxIdType'

Defined in StripeAPI.Types.TaxId

Methods

showsPrec :: Int -> TaxIdType' -> ShowS

show :: TaxIdType' -> String

showList :: [TaxIdType'] -> ShowS

ToJSON TaxIdType'

Defined in StripeAPI.Types.TaxId

Methods

toJSON :: TaxIdType' -> Value

toEncoding :: TaxIdType' -> Encoding

toJSONList :: [TaxIdType'] -> Value

toEncodingList :: [TaxIdType'] -> Encoding

FromJSON TaxIdType'

Defined in StripeAPI.Types.TaxId

Methods

parseJSON :: Value -> Parser TaxIdType'

parseJSONList :: Value -> Parser [TaxIdType']

data TaxIdVerification'

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

Tax ID verification information.

Constructors

TaxIdVerification'

Fields

• taxIdVerification'Status :: Maybe TaxIdVerification'Status'

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

• taxIdVerification'VerifiedAddress :: Maybe Text

  verified_address: Verified address.

  Constraints:

  • Maximum length of 5000
• taxIdVerification'VerifiedName :: Maybe Text

  verified_name: Verified name.

  Constraints:

  • Maximum length of 5000

Instances

Eq TaxIdVerification'

Defined in StripeAPI.Types.TaxId

Methods

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

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

Show TaxIdVerification'

Defined in StripeAPI.Types.TaxId

Methods

showsPrec :: Int -> TaxIdVerification' -> ShowS

show :: TaxIdVerification' -> String

showList :: [TaxIdVerification'] -> ShowS

ToJSON TaxIdVerification'

Defined in StripeAPI.Types.TaxId

Methods

toJSON :: TaxIdVerification' -> Value

toEncoding :: TaxIdVerification' -> Encoding

toJSONList :: [TaxIdVerification'] -> Value

toEncodingList :: [TaxIdVerification'] -> Encoding

FromJSON TaxIdVerification'

Defined in StripeAPI.Types.TaxId

Methods

parseJSON :: Value -> Parser TaxIdVerification'

parseJSONList :: Value -> Parser [TaxIdVerification']

mkTaxIdVerification' :: TaxIdVerification'

Create a new TaxIdVerification' with all required fields.

data TaxIdVerification'Status'

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"

Instances

Eq TaxIdVerification'Status'

Defined in StripeAPI.Types.TaxId

Methods

(==) :: TaxIdVerification'Status' -> TaxIdVerification'Status' -> Bool

(/=) :: TaxIdVerification'Status' -> TaxIdVerification'Status' -> Bool

Show TaxIdVerification'Status'

Defined in StripeAPI.Types.TaxId

Methods

showsPrec :: Int -> TaxIdVerification'Status' -> ShowS

show :: TaxIdVerification'Status' -> String

showList :: [TaxIdVerification'Status'] -> ShowS

ToJSON TaxIdVerification'Status'

Defined in StripeAPI.Types.TaxId

Methods

toJSON :: TaxIdVerification'Status' -> Value

toEncoding :: TaxIdVerification'Status' -> Encoding

toJSONList :: [TaxIdVerification'Status'] -> Value

toEncodingList :: [TaxIdVerification'Status'] -> Encoding

FromJSON TaxIdVerification'Status'

Defined in StripeAPI.Types.TaxId

Methods

parseJSON :: Value -> Parser TaxIdVerification'Status'

parseJSONList :: Value -> Parser [TaxIdVerification'Status']