Show / Hide Table of Contents

Class Address

Class representing an EasyPost address.

Inheritance
System.Object
EphemeralEasyPostObject
EasyPostObject
Address
Implements
IEasyPostObject
IAddressParameter
IParameter
Inherited Members
EasyPostObject.CreatedAt
EasyPostObject.Id
EasyPostObject.UpdatedAt
EasyPostObject.Prefix
EasyPostObject.AsDictionary()
EasyPostObject.ToString()
EasyPostObject.Equals(Nullable<Object>)
EasyPostObject.GetHashCode()
EphemeralEasyPostObject.Mode
EphemeralEasyPostObject.AsJson()
Namespace: EasyPost.Models.API
Assembly: EasyPost.dll
Syntax
public class Address : EasyPostObject, IEasyPostObject, IAddressParameter, IParameter

Properties

| Improve this Doc View Source

CarrierFacility

The specific designation for the address (only relevant if the address is a carrier facility).

Declaration
public string? CarrierFacility { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

City

The city the address is located in.

Declaration
public string? City { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Company

The name of the company.

Declaration
public string? Company { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Country

The ISO 3166 code of the country the address is located in.

Declaration
public string? Country { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Email

The email address of the person or organization.

Declaration
public string? Email { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Error

Potential error encountered while processing the address.

Declaration
public string? Error { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

FederalTaxId

The federal tax ID of the person or organization.

Declaration
public string? FederalTaxId { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Message

A human-readable message for any errors that occurred during the address's life cycle.

Declaration
public string? Message { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Name

The name of the person or organization.

Declaration
public string? Name { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Phone

The phone number of the person or organization.

Declaration
public string? Phone { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Residential

Whether the address is a residential address.

Declaration
public bool? Residential { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>
| Improve this Doc View Source

State

The state the address is located in.

Declaration
public string? State { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

StateTaxId

The state tax ID of the person or organization.

Declaration
public string? StateTaxId { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Street1

The first line of the street address.

Declaration
public string? Street1 { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Street2

The second line of the street address.

Declaration
public string? Street2 { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Verifications

The result of any verifications.

Declaration
public Verifications Verifications { get; set; }
Property Value
Type Description
Verifications
| Improve this Doc View Source

Zip

The zip code the address is located in.

Declaration
public string? Zip { get; set; }
Property Value
Type Description
System.Nullable<System.String>

Implements

IEasyPostObject
IAddressParameter
IParameter
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX