MYA
API Reference
Objects
ApiSubscriptionResult
ApiSubscriptionResult
Introduction
Represents a subscription returned by GetSubscriptionsByPageAsync.
Properties
ActiveSubscriptionCount
The number of active subscriptions per ContractLineItemId.
AutoRenewalTerm
The auto-renewal term in months, if applicable.
BillingEndDate
The billing end date (termination date) of the subscription.
BillingStartDate
The billing start date.
CompanyName
The name of the Customer (UserCompany) associated with this subscription.
ContractEndDate
The end date of the contract.
ContractLineItemId
The contract line item ID that identifies this subscription.
ContractStartDate
The start date of the contract.
CreditEndDate
The end date of the promotional credit period.
CreditPrice
The amount that will be credited per subscription during the credit period.
CurrencyCode
The currency code for the subscription (e.g., USD, CAD).
DeviceInfo
The list of devices associated with this subscription, including serial numbers and VINs.
EtfPerUnit
The early termination fee per unit.
EtfTotal
The total early termination fee.
MonthlyCostPerUnit
The monthly cost per subscription unit.
MonthlyCostTotal
The total monthly cost of all subscriptions in a ContractLineItemId group.
MonthsRemaining
The number of months remaining in the contract term.
PromotionalCreditTotal
The total promotional credit across all active subscriptions in a ContractLineItemId group.
SubscriptionName
The name of the subscription.
SubscriptionStatus
The current status of the subscription.
Loading API Runner...