Class Insurance

Class representing an EasyPost insurance object.

Inheritance
System.Object
EphemeralEasyPostObject
EasyPostObject
Insurance
Implements
Inherited Members
Namespace: EasyPost.Models.API
Assembly: EasyPost.dll
Syntax
public class Insurance : EasyPostObject, IEasyPostObject, IInsuranceParameter, IParameter

Properties

| Improve this Doc View Source

Amount

The value of the insured goods, in US cents with sub-cent precision.

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

Fee

The Fee for the insurance.

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

FromAddress

The Address from which the shipment is being sent.

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

Messages

A list of errors encountered during the attempted purchase of the insurance.

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

Provider

The insurance provider used by EasyPost.

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

ProviderId

The identifying number for some insurance providers used by EasyPost.

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

Reference

An optional field that may be used in place of ID in some API endpoints.

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

ShipmentId

The ID of the Shipment being insured, if postage was purchased through EasyPost.

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

Status

The current status of the insurance. Possible values include "new", "pending", "purchased", "failed" and "cancelled".

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

ToAddress

The Address to which the shipment is being sent.

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

Tracker

The Tracker associated with this insurance.

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

TrackingCode

The tracking code of either the Shipment created using EasyPost, or provided by the user during creation of the insurance.

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

Implements