LocationBase

  • account_id
    Type: string · Account Id
    required
  • id
    Type: string · Id
    required
  • name
    Type: string · Name
    required
  • address
    Type: object · Address nullable
    • city
      Type: string · City
      required
    • state
      Type: string · State
      required
    • street_line1
      Type: string · Street Line1
      required
    • zip
      Type: string · Zip
      required
    • street_line2
      Type: string · Street Line2
  • country_code
    Type: string | null · Country Code
  • created_at
    Type: string | null · Created AtFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • currency
    Type: string | null · Currency
  • deleted_at
    Type: string | null · Deleted AtFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • email
    Type: string | null · Email
  • metadata
    Type: object | null · Metadata
  • phone
    Type: string | null · Phone
  • processor_config_id
    Type: string | null · Processor Config Id
  • status
    Type: string · Status
  • surcharge_rate
    Type: number | null · Surcharge Rate

    Surcharge percentage (e.g., 3.5 for 3.5%). Setting to null disables automatic surcharge logic. Setting to 0 means surcharges will NEVER be applied unless explicitly overridden.

  • terminal_id
    Type: string | null · Terminal Id
  • updated_at
    Type: string | null · Updated AtFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z