Class ReferralCustomer

Class representing an EasyPost referral customer.

Inheritance

System.Object

EphemeralEasyPostObject

EasyPostObject

ReferralCustomer

Implements

IEasyPostObject

IReferralCustomerParameter

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 ReferralCustomer : EasyPostObject, IEasyPostObject, IReferralCustomerParameter, IParameter

Properties

ApiKeys

A list of the ApiKeys associated with this user.

Declaration

public List<ApiKey>? ApiKeys { get; set; }

Property Value

Type	Description
System.Nullable<List<ApiKey>>

Balance

The user's current account balance. Formatted as USD dollars and cents to five decimal places (e.g. "10.00000").

Declaration

public string? Balance { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

Children

A list of associated child users.

Declaration

public List<User>? Children { get; set; }

Property Value

Type	Description
System.Nullable<List<User>>

ConvenienceFeeRate

The fee rate for convenience fees. Formatted as a decimal percentage (e.g. "0.005").

Declaration

public string? ConvenienceFeeRate { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

Email

The user's email address.

Declaration

public string? Email { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

InsuranceFeeMinimum

The minimum cost for insurance purchases. Formatted as USD dollars and cents, delimited by a decimal point (e.g. "10.00").

Declaration

public string? InsuranceFeeMinimum { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

InsuranceFeeRate

The fee rate for insurance purchases. Formatted as a decimal percentage (e.g. "0.005").

Declaration

public string? InsuranceFeeRate { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

Name

The user's full name.

Declaration

public string? Name { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

ParentId

The ID of the user's parent user, if the user is a child user. If the user is a parent user, this field will be null.

Declaration

public string? ParentId { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

Password

Class representing an EasyPost referral customer.

Declaration

public string? Password { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

PasswordConfirmation

Class representing an EasyPost referral customer.

Declaration

public string? PasswordConfirmation { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

PhoneNumber

The user's phone number.

Declaration

public string? PhoneNumber { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

PricePerShipment

The average price per shipment for the user's account. Formatted as USD dollars and cents to five decimals places (e.g. "10.00000").

Declaration

public string? PricePerShipment { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

RechargeAmount

Primary recharge amount for the user's balance. Formatted as USD dollars and cents, delimited by a decimal point (e.g. "10.00").

Declaration

public string? RechargeAmount { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

RechargeThreshold

Number of USD cents that, upon the user's account balance dropping below, trigger an automatic balance recharge using the RechargeAmount and PrimaryPaymentMethod.

Declaration

public string? RechargeThreshold { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

SecondaryRechargeAmount

Secondary recharge amount for the user's balance. Formatted as USD dollars and cents, delimited by a decimal point (e.g. "10.00").

Declaration

public string? SecondaryRechargeAmount { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

Implements

IEasyPostObject

IReferralCustomerParameter

IParameter