StripeAPI.Types.Address

Contains the types generated from the schema Address

Documentation

data Address

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

Constructors

Address

Fields

• addressCity :: Maybe Text

  city: City, district, suburb, town, or village.

  Constraints:

  • Maximum length of 5000
• addressCountry :: 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
• addressLine1 :: Maybe Text

  line1: Address line 1 (e.g., street, PO Box, or company name).

  Constraints:

  • Maximum length of 5000
• addressLine2 :: Maybe Text

  line2: Address line 2 (e.g., apartment, suite, unit, or building).

  Constraints:

  • Maximum length of 5000
• addressPostalCode :: Maybe Text

  postal_code: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• addressState :: Maybe Text

  state: State, county, province, or region.

  Constraints:

  • Maximum length of 5000

Instances

Eq Address

Defined in StripeAPI.Types.Address

Methods

(==) :: Address -> Address -> Bool

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

Show Address

Defined in StripeAPI.Types.Address

Methods

showsPrec :: Int -> Address -> ShowS

show :: Address -> String

showList :: [Address] -> ShowS

ToJSON Address

Defined in StripeAPI.Types.Address

Methods

toJSON :: Address -> Value

toEncoding :: Address -> Encoding

toJSONList :: [Address] -> Value

toEncodingList :: [Address] -> Encoding

FromJSON Address

Defined in StripeAPI.Types.Address

Methods

parseJSON :: Value -> Parser Address

parseJSONList :: Value -> Parser [Address]

mkAddress :: Address

Create a new Address with all required fields.