stripe/customer

The [Customer] type, associated types, and associated functions. All implementations as per https://stripe.com/docs/api/customers.

Types

pub type Address {
  Address(
    city: Option(String),
    country: Option(String),
    line1: Option(String),
    line2: Option(String),
    postal_cose: Option(String),
    state: Option(String),
  )
}

Constructors

  • Address(
      city: Option(String),
      country: Option(String),
      line1: Option(String),
      line2: Option(String),
      postal_cose: Option(String),
      state: Option(String),
    )
pub type AutomaticTax {
  Failed
  NotCollecting
  Supported
  UnrecognizedLocation
}

Constructors

  • Failed
  • NotCollecting
  • Supported
  • UnrecognizedLocation
pub type CashBalance {
  CashBalance(
    object: String,
    available: Option(String),
    customer: String,
    livemode: Bool,
    settings: CashBalanceSettings,
  )
}

Constructors

  • CashBalance(
      object: String,
      available: Option(String),
      customer: String,
      livemode: Bool,
      settings: CashBalanceSettings,
    )
pub type CashBalanceSettings {
  CashBalanceSettings(
    reconciliation_mode: ReconiliationMode,
    using_merchant_default: Bool,
  )
}

Constructors

  • CashBalanceSettings(
      reconciliation_mode: ReconiliationMode,
      using_merchant_default: Bool,
    )
pub type Coupon {
  Coupon(
    id: String,
    object: String,
    amount_off: Option(Int),
    applies_to: Option(CouponAppliesTo),
    created: Timestamp,
    currency: Option(Currency),
    currency_options: Option(Dict(Currency, CurrencyOption)),
    duration: Duration,
    duration_in_months: Option(Int),
    livemode: Bool,
    max_redemptions: Option(Int),
    metadata: Option(Dict(String, String)),
    name: Option(String),
    percent_off: Option(Float),
    redeem_by: Option(Timestamp),
    times_redeemed: Int,
    valid: Bool,
  )
}

Constructors

  • Coupon(
      id: String,
      object: String,
      amount_off: Option(Int),
      applies_to: Option(CouponAppliesTo),
      created: Timestamp,
      currency: Option(Currency),
      currency_options: Option(Dict(Currency, CurrencyOption)),
      duration: Duration,
      duration_in_months: Option(Int),
      livemode: Bool,
      max_redemptions: Option(Int),
      metadata: Option(Dict(String, String)),
      name: Option(String),
      percent_off: Option(Float),
      redeem_by: Option(Timestamp),
      times_redeemed: Int,
      valid: Bool,
    )
pub type CouponAppliesTo {
  List(String)
}

Constructors

  • List(String)
pub type Currency {
  USD
  AED
  AFN
  ALL
  AMD
  ANG
  AOA
  ARS
  AUD
  AWG
  AZN
  BAM
  BBD
  BDT
  BGN
  BIF
  BMD
  BND
  BOB
  BRL
  BSD
  BWP
  BYN
  BZD
  CAD
  CDF
  CHF
  CLP
  CNY
  COP
  CRC
  CVE
  CZK
  DJF
  DKK
  DOP
  DZD
  EGP
  ETB
  EUR
  FJD
  FKP
  GBP
  GEL
  GIP
  GMD
  GNF
  GTQ
  GYD
  HKD
  HNL
  HTG
  HUF
  IDR
  ILS
  INR
  ISK
  JMD
  JPY
  KES
  KGS
  KHR
  KMF
  KRW
  KYD
  KZT
  LAK
  LBP
  LKR
  LRD
  LSL
  MAD
  MDL
  MGA
  MKD
  MMK
  MNT
  MOP
  MUR
  MVR
  MWK
  MXN
  MYR
  MZN
  NAD
  NGN
  NIO
  NOK
  NPR
  NZD
  PAB
  PEN
  PGK
  PHP
  PKR
  PLN
  PYG
  QAR
  RON
  RSD
  RUB
  RWF
  SAR
  SBD
  SCR
  SEK
  SGD
  SHP
  SLE
  SOS
  SRD
  STD
  SZL
  THB
  TJS
  TOP
  TRY
  TTD
  TWD
  TZS
  UAH
  UGX
  UYU
  UZS
  VND
  VUV
  WST
  XAF
  XCD
  XOF
  XPF
  YER
  ZAR
  ZMW
  BHD
  JOD
  KWD
  OMR
  TND
}

Constructors

  • USD
  • AED
  • AFN
  • ALL
  • AMD
  • ANG
  • AOA
  • ARS
  • AUD
  • AWG
  • AZN
  • BAM
  • BBD
  • BDT
  • BGN
  • BIF
  • BMD
  • BND
  • BOB
  • BRL
  • BSD
  • BWP
  • BYN
  • BZD
  • CAD
  • CDF
  • CHF
  • CLP
  • CNY
  • COP
  • CRC
  • CVE
  • CZK
  • DJF
  • DKK
  • DOP
  • DZD
  • EGP
  • ETB
  • EUR
  • FJD
  • FKP
  • GBP
  • GEL
  • GIP
  • GMD
  • GNF
  • GTQ
  • GYD
  • HKD
  • HNL
  • HTG
  • HUF
  • IDR
  • ILS
  • INR
  • ISK
  • JMD
  • JPY
  • KES
  • KGS
  • KHR
  • KMF
  • KRW
  • KYD
  • KZT
  • LAK
  • LBP
  • LKR
  • LRD
  • LSL
  • MAD
  • MDL
  • MGA
  • MKD
  • MMK
  • MNT
  • MOP
  • MUR
  • MVR
  • MWK
  • MXN
  • MYR
  • MZN
  • NAD
  • NGN
  • NIO
  • NOK
  • NPR
  • NZD
  • PAB
  • PEN
  • PGK
  • PHP
  • PKR
  • PLN
  • PYG
  • QAR
  • RON
  • RSD
  • RUB
  • RWF
  • SAR
  • SBD
  • SCR
  • SEK
  • SGD
  • SHP
  • SLE
  • SOS
  • SRD
  • STD
  • SZL
  • THB
  • TJS
  • TOP
  • TRY
  • TTD
  • TWD
  • TZS
  • UAH
  • UGX
  • UYU
  • UZS
  • VND
  • VUV
  • WST
  • XAF
  • XCD
  • XOF
  • XPF
  • YER
  • ZAR
  • ZMW
  • BHD
  • JOD
  • KWD
  • OMR
  • TND
pub type CurrencyOption {
  CurrencyOption(amount_off: Int)
}

Constructors

  • CurrencyOption(amount_off: Int)
pub type CustomField {
  CustomField(name: String, value: String)
}

Constructors

  • CustomField(name: String, value: String)
pub type Customer {
  Customer(
    id: String,
    object: String,
    address: Option(Address),
    balance: Int,
    cash_balance: Option(CashBalance),
    created: Int,
    currency: Option(String),
    default_source: Option(String),
    delinquent: Bool,
    description: Option(String),
    discount: Option(Discount),
    email: Option(String),
    invoice_prefix: Option(String),
    invoice_settings: Option(InvoiceSettings),
    livemode: Bool,
    metadata: Option(Dict(String, String)),
    name: Option(String),
    next_invoice_sequence: Option(Int),
    phone: Option(String),
    preferred_locales: Option(List(String)),
    shipping: Option(Shipping),
    sources: Option(Sources),
    tax: Tax,
    tax_exempt: Option(TaxExempt),
    tax_ids: Option(TaxIds),
    test_clock: Option(String),
  )
}

Constructors

  • Customer(
      id: String,
      object: String,
      address: Option(Address),
      balance: Int,
      cash_balance: Option(CashBalance),
      created: Int,
      currency: Option(String),
      default_source: Option(String),
      delinquent: Bool,
      description: Option(String),
      discount: Option(Discount),
      email: Option(String),
      invoice_prefix: Option(String),
      invoice_settings: Option(InvoiceSettings),
      livemode: Bool,
      metadata: Option(Dict(String, String)),
      name: Option(String),
      next_invoice_sequence: Option(Int),
      phone: Option(String),
      preferred_locales: Option(List(String)),
      shipping: Option(Shipping),
      sources: Option(Sources),
      tax: Tax,
      tax_exempt: Option(TaxExempt),
      tax_ids: Option(TaxIds),
      test_clock: Option(String),
    )
pub type Discount {
  Discount(
    id: String,
    object: String,
    checkout_session: Option(String),
    coupon: Coupon,
    customer: Option(String),
    end: Option(Timestamp),
    invoice: Option(String),
    invoice_item: Option(String),
    promotion_code: Option(String),
    start: Timestamp,
    subscription: Option(String),
    subscription_item: Option(String),
  )
}

Constructors

  • Discount(
      id: String,
      object: String,
      checkout_session: Option(String),
      coupon: Coupon,
      customer: Option(String),
      end: Option(Timestamp),
      invoice: Option(String),
      invoice_item: Option(String),
      promotion_code: Option(String),
      start: Timestamp,
      subscription: Option(String),
      subscription_item: Option(String),
    )
pub type Duration {
  Forever
  Once
  Repeating
}

Constructors

  • Forever
  • Once
  • Repeating
pub type InvoiceSettings {
  InvoiceSettings(
    custom_fields: Option(List(CustomField)),
    default_payment_method: Option(String),
    footer: Option(String),
    rendering_options: Option(RenderingOptions),
  )
}

Constructors

  • InvoiceSettings(
      custom_fields: Option(List(CustomField)),
      default_payment_method: Option(String),
      footer: Option(String),
      rendering_options: Option(RenderingOptions),
    )
pub type Location {
  Location(
    country: String,
    source: String,
    state: Option(String),
  )
}

Constructors

  • Location(country: String, source: String, state: Option(String))
pub type PayoutMethod {
  Instant
  Standard
}

Constructors

  • Instant
  • Standard
pub type ReconiliationMode {
  Automatic
  Manual
}

Constructors

  • Automatic
  • Manual
pub type RenderingOptions {
  RenderingOptions
}

Constructors

  • RenderingOptions
pub type Shipping {
  Shipping(address: Address, name: String, phone: Option(String))
}

Constructors

  • Shipping(address: Address, name: String, phone: Option(String))
pub type Source {
  Source(
    id: String,
    object: String,
    account: Option(String),
    account_holder_name: Option(String),
    account_holder_type: Option(String),
    account_type: Option(String),
    available_payout_methods: Option(List(PayoutMethod)),
    bank_name: Option(String),
    country: String,
    currency: Currency,
    customer: Option(String),
    fingerprint: Option(String),
    last4: String,
    metadata: Option(Dict(String, String)),
    routing_number: Option(String),
    status: String,
    has_more: Bool,
    url: String,
  )
}

Constructors

  • Source(
      id: String,
      object: String,
      account: Option(String),
      account_holder_name: Option(String),
      account_holder_type: Option(String),
      account_type: Option(String),
      available_payout_methods: Option(List(PayoutMethod)),
      bank_name: Option(String),
      country: String,
      currency: Currency,
      customer: Option(String),
      fingerprint: Option(String),
      last4: String,
      metadata: Option(Dict(String, String)),
      routing_number: Option(String),
      status: String,
      has_more: Bool,
      url: String,
    )
pub type Sources {
  Sources(
    object: String,
    data: List(Source),
    has_more: Bool,
    url: String,
  )
}

Constructors

  • Sources(
      object: String,
      data: List(Source),
      has_more: Bool,
      url: String,
    )
pub type Tax {
  Tax(
    automatic_tax: Option(AutomaticTax),
    ip_address: Option(String),
    location: Option(Location),
  )
}

Constructors

  • Tax(
      automatic_tax: Option(AutomaticTax),
      ip_address: Option(String),
      location: Option(Location),
    )
pub type TaxExempt {
  Exempt
  None
  Reverse
}

Constructors

  • Exempt
  • None
  • Reverse
pub type TaxId {
  TaxId(
    id: String,
    object: String,
    country: Option(String),
    created: Timestamp,
    customer: Option(String),
    livemode: Bool,
    owner: Option(TaxIdOwner),
    type_: TaxIdType,
    value: String,
    verification: Option(TaxIdVerification),
  )
}

Constructors

  • TaxId(
      id: String,
      object: String,
      country: Option(String),
      created: Timestamp,
      customer: Option(String),
      livemode: Bool,
      owner: Option(TaxIdOwner),
      type_: TaxIdType,
      value: String,
      verification: Option(TaxIdVerification),
    )
pub type TaxIdOwner {
  Owner(
    account: Option(String),
    application: Option(String),
    customer: Option(String),
    type_: TaxIdOwnerType,
  )
}

Constructors

  • Owner(
      account: Option(String),
      application: Option(String),
      customer: Option(String),
      type_: TaxIdOwnerType,
    )
pub type TaxIdOwnerType {
  Account
  Application
  CustomerType
  Self
}

Constructors

  • Account
  • Application
  • CustomerType
  • Self
pub type TaxIdType {
  AdNrt
  AeTrn
  ArCuit
  AuAbn
  AuArn
  BgUic
  BhVat
  BoTin
  BrCnpj
  BrCpf
  CaBn
  CaGstHst
  CaPstBc
  CaPstMb
  CaPstSk
  CaQst
  ChVat
  ClTin
  CnTin
  CoNit
  CrTin
  DoRcn
  EcRuc
  EgTin
  EsCif
  EuOssVat
  EuVat
  GbVat
  GeVat
  HkBr
  HuTin
  IdNpwp
  IlVat
  InGst
  IsVat
  JpCn
  JpRn
  JpTrn
  KePin
  KrBrn
  KzBin
  LiUid
  MxRfc
  MyFrp
  MyItn
  MySst
  NgTin
  NoVat
  NoVoec
  NzGst
  OmVat
  PeRuc
  PhTin
  RoTin
  RsPib
  RuInn
  RuKpp
  SaVat
  SgGst
  SgUen
  SiTin
  SvNit
  ThVat
  TrTin
  TwVat
  UaVat
  UsEin
  UyRuc
  VeRif
  VnTin
  ZaVat
  Unknown
}

Constructors

  • AdNrt
  • AeTrn
  • ArCuit
  • AuAbn
  • AuArn
  • BgUic
  • BhVat
  • BoTin
  • BrCnpj
  • BrCpf
  • CaBn
  • CaGstHst
  • CaPstBc
  • CaPstMb
  • CaPstSk
  • CaQst
  • ChVat
  • ClTin
  • CnTin
  • CoNit
  • CrTin
  • DoRcn
  • EcRuc
  • EgTin
  • EsCif
  • EuOssVat
  • EuVat
  • GbVat
  • GeVat
  • HkBr
  • HuTin
  • IdNpwp
  • IlVat
  • InGst
  • IsVat
  • JpCn
  • JpRn
  • JpTrn
  • KePin
  • KrBrn
  • KzBin
  • LiUid
  • MxRfc
  • MyFrp
  • MyItn
  • MySst
  • NgTin
  • NoVat
  • NoVoec
  • NzGst
  • OmVat
  • PeRuc
  • PhTin
  • RoTin
  • RsPib
  • RuInn
  • RuKpp
  • SaVat
  • SgGst
  • SgUen
  • SiTin
  • SvNit
  • ThVat
  • TrTin
  • TwVat
  • UaVat
  • UsEin
  • UyRuc
  • VeRif
  • VnTin
  • ZaVat
  • Unknown
pub type TaxIdVerification {
  TaxIdVerification(
    status: TaxIdVerificationStatus,
    verified_address: Option(String),
    verified_name: Option(String),
  )
}

Constructors

  • TaxIdVerification(
      status: TaxIdVerificationStatus,
      verified_address: Option(String),
      verified_name: Option(String),
    )
pub type TaxIdVerificationStatus {
  Pending
  Unavailable
  Unverified
  Verified
}

Constructors

  • Pending
  • Unavailable
  • Unverified
  • Verified
pub type TaxIds {
  TaxIds(
    object: String,
    data: List(TaxId),
    has_more: Bool,
    url: String,
  )
}

Constructors

  • TaxIds(
      object: String,
      data: List(TaxId),
      has_more: Bool,
      url: String,
    )
pub type Timestamp {
  Int
}

Constructors

  • Int
Search Document