SubscriptionChargesEventAttributes
Defines subscription charge events fields/properties.
| Name | Description | Type | Additional Information |
|---|---|---|---|
| ChargeCode |
Unique identifier of the charge. |
string |
None. |
| ChargeName |
Name of the subscription charge. |
string |
None. |
| ChargeType |
Type of charge. Valid values are:Recurring and One-Time. |
string |
None. |
| ProductName |
Name of the product associated with the charge. |
string |
None. |
| ProductType |
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 and 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 |
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 |
Currency for reporting the charge, for example, USD. |
string |
None. |
| Quantity |
Number of units for the charge. |
decimal number |
None. |
| PreviousQuantity |
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 and One-Time. |
string |
None. |
| Description |
Description of the charge. |
string |
None. |
| SubscriptionStartDate |
Start date of the subscription. |
date |
None. |
| SubscriptionCanceled |
Indicates whether the subscription was canceled. Valid values are: true and false. |
boolean |
None. |
| SubscriptionCanceledDate |
Date when the subscription was canceled. |
date |
None. |
| InitialTerm |
First subscription term (in months) eligible for a discount. For example, 1, 12 or 24. |
integer |
None. |
| CurrentTerm |
Current subscription term (in months) eligible for a discount. For example, 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 |
Start date of the current subscription. |
date |
None. |
| TermEndDate |
End date of the current subscription. |
date |
None. |
| IsTrial |
Indicates whether the subscription is a trial. Valid values are: true and 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 and false. |
boolean |
None. |
| EffectiveDate |
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 |
End date of the subscription. |
date |
None. |
| SubscriptionProductUpdated |
Indicates whether the product was changed in the subscription. Valid values are: true and false. |
boolean |
None. |
| SubscriptionProductUpdatedDate |
Date when the product was changed in the subscription. |
date |
None. |
| CustomerName |
Name of the customer. |
string |
None. |
| CustomerType |
Type of customer. Valid values are: Direct, Resold, Referred and Partner. |
string |
None. |