GET v2/TcuSubscriptions/Vin/{vin}

Gets TCU subscription details for the asset with the supplied VIN.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
vin

string

Required

Body Parameters

None.

Response Information

Resource Description

Lhp.EquipmentIntelligence.WebApi.Models.V2.TcuSubscription.TcuSubscription
NameDescriptionTypeAdditional information
planName

The subscription name

string

None.

startsOn

If not idle, the date on which the subcription started (formatted yyyy-MM-dd)

string

None.

expiresOn

The date on which the subscription expires (formatted yyyy-MM-dd)

string

None.

bridgeStartedOn

The date on which the bridge period of a bridged subscription started (formatted yyyy-MM-dd)

string

None.

bridgeExpiredOn

The date on which the bridge period of a bridged subscription ended (formatted yyyy-MM-dd)

string

None.

status

The current status of the subscription

string

None.

autoRenewStatus

Whether or not the subscription is set to auto-renew at the end of the current subscription period

boolean

None.

autoRenewStatusLastUpdatedBy

The user that last updated the auto-renew status of the subscription

string

None.

autoRenewStatusLastUpdatedOn

The date/time on which the auto-renew status of the subscription was last updated

date

None.

autoRenewReferenceNumber

The customer-supplied reference number for the auto-renewal of the subscription

string

None.

referenceNumber

The customer-supplied reference number for the new subscription or renewal

string

None.

invoiceNumber

The customer-supplied reference number for the new subscription or renewal

string

None.

tcuType

The TCU type name

string

None.

tcuIdentifier

The TCU identifier

string

None.

tcuImei

The TCU IMEI

string

None.

tcuSerialNumber

The TCU serial number

string

None.

tcuLastReportedUtc

The date/time the TCU last reported

string

None.

assetName

The name of the asset on which the TCU is installed

string

None.

assetVin

The VIN of the asset on which the TCU is installed

string

None.

assetSerialNumber

The Serial Number of the asset on which the TCU is installed

string

None.

lastModifiedUtc

The date/time the subscription was last modified

string

None.

createReason

The reason why the subscription row was created

Lhp.EquipmentIntelligence.CustomerTcuSubscriptionCreateReasons

None.

subscriptionIdentifier

The subscription identifier

string

None.

Response Formats

application/json, text/json

Sample:
{
  "planName": "sample string 1 (1 Month)",
  "startsOn": "sample string 5",
  "expiresOn": "sample string 6",
  "bridgeStartedOn": "sample string 7",
  "bridgeExpiredOn": "sample string 8",
  "status": "sample string 9",
  "autoRenewStatusLastUpdatedBy": "sample string 11",
  "autoRenewStatusLastUpdatedOn": "2026-07-02T01:12:16.3016121+00:00",
  "autoRenewReferenceNumber": "sample string 12",
  "referenceNumber": "sample string 13",
  "invoiceNumber": "sample string 14",
  "tcuType": "sample string 15",
  "tcuIdentifier": "sample string 16",
  "tcuImei": "sample string 17",
  "tcuSerialNumber": "sample string 18",
  "tcuLastReportedUtc": "sample string 19",
  "assetName": "sample string 20",
  "assetVin": "sample string 21",
  "assetSerialNumber": "sample string 22",
  "lastModifiedUtc": "2026-07-02T01:12:16Z",
  "createReason": "InitialPurchase",
  "subscriptionIdentifier": "202607020112"
}

application/xml, text/xml

Sample:
<TcuSubscription xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PlanName>sample string 1 (1 Month)</PlanName>
  <StartsOn>sample string 5</StartsOn>
  <ExpiresOn>sample string 6</ExpiresOn>
  <BridgeStartedOn>sample string 7</BridgeStartedOn>
  <BridgeExpiredOn>sample string 8</BridgeExpiredOn>
  <Status>sample string 9</Status>
  <AutoRenewStatusLastUpdatedBy>sample string 11</AutoRenewStatusLastUpdatedBy>
  <AutoRenewStatusLastUpdatedOn>2026-07-02T01:12:16.3016121+00:00</AutoRenewStatusLastUpdatedOn>
  <AutoRenewReferenceNumber>sample string 12</AutoRenewReferenceNumber>
  <ReferenceNumber>sample string 13</ReferenceNumber>
  <BillingInvoiceNumber>sample string 14</BillingInvoiceNumber>
  <TcuType>sample string 15</TcuType>
  <TcuIdentifier>sample string 16</TcuIdentifier>
  <TcuImei>sample string 17</TcuImei>
  <TcuSerialNumber>sample string 18</TcuSerialNumber>
  <TcuLastReportedUtc>sample string 19</TcuLastReportedUtc>
  <AssetName>sample string 20</AssetName>
  <AssetVin>sample string 21</AssetVin>
  <AssetSerialNumber>sample string 22</AssetSerialNumber>
  <LastModifiedUtc>2026-07-02T01:12:16Z</LastModifiedUtc>
  <CreateReason>InitialPurchase</CreateReason>
  <SubscriptionIdentifier>202607020112</SubscriptionIdentifier>
</TcuSubscription>