SubscriptionChargesEventAttributes
Defines subscription charge events fields/properties.
Name | Description | Type | Additional Information |
---|---|---|---|
ChargeCode |
The Unique identifier of the charge. |
string |
None. |
ChargeName |
The Name of the subscription charge. |
string |
None. |
ChargeType |
The Type of charge. Valid values are: Recurring, One-Time. |
string |
None. |
ProductName |
The Name of the product associated with the charge. |
string |
None. |
ProductType |
The platform of the product associated with the charge. The productType is used primarily for automated provisioning, but is also used for grouping and roll-ups in reports. |
string |
None. |
IsOffice365Nce |
Indicates whether the charge is for a Microsoft Office 365 New Commerce Experience (NCE) subscription. Valid values are: true, false. |
boolean |
None. |
BillableItem |
The usage counter for determining the number of units for the charge. |
string |
None. |
Price |
Unit price. |
decimal number |
None. |
TermPrice |
The unit price for the term of the subscription. If the charge is billed monthly or is a one-time charge, the termPrice is the same as the price. If the charge is billed annually, the termPrice is 12 times the price. |
decimal number |
None. |
Currency |
The currency for reporting the charge (e.g., USD). |
string |
None. |
Quantity |
The number of units for the charge. |
decimal number |
None. |
PreviousQuantity |
The number of units before the current charge. |
decimal number |
None. |
Total |
The total charge amount. |
decimal number |
None. |
EventType |
Type of subscription charge event. Valid values are: Recurring, Adjustment, One-Time. |
string |
None. |
Description |
The description of the charge. |
string |
None. |
SubscriptionStartDate |
The start date of the subscription. |
date |
None. |
SubscriptionCanceled |
Indicates whether the subscription was canceled. Valid values are: true, false. |
boolean |
None. |
SubscriptionCanceledDate |
The date when the subscription was canceled. |
Object |
None. |
InitialTerm |
The first subscription term, in months, eligible for a discount (e.g., 1, 12 or 24). |
integer |
None. |
CurrentTerm |
The current subscription term, in months, eligible for a discount (e.g., 1, 12 or 24). |
integer |
None. |
CommitmentTerm |
For Office365 only. Indicates the commitment term, in months, for the current subscription. If the current commitment is for an annual subscription with monthly billing, the commitmentTerm is 12. |
integer |
None. |
TermStartDate |
The start date of the current subscription. |
date |
None. |
TermEndDate |
The end date of the current subscription. |
date |
None. |
IsTrial |
Indicates whether the subscription is a trial. Valid values are: true, false. |
boolean |
None. |
IsAutoRenew |
Indicates whether the subscription automatically renews when it expires or, if it is a trial, converts to a subscription. Valid values are: true , false. |
boolean |
None. |
EffectiveDate |
The earliest date that the charge can be posted to the billing account. For a recurring or one-time charge, the effectiveDate is at the start of the subscription. |
date |
None. |
EndDate |
The end date of the subscription. |
Object |
None. |
SubscriptionProductUpdated |
Indicates whether the product was changed in the subscription. Valid values are: true, false. |
boolean |
None. |
SubscriptionProductUpdatedDate |
The date when the product was changed in the subscription. |
Object |
None. |
CustomerName |
The name of the customer. |
string |
None. |
CustomerType |
Type of customer. Valid values are: Direct, Resold, Referred, Partner. |
string |
None. |