Class LineItemSubscriptionReportingModel
The line item model for subscription reports.
Inheritance
Inherited Members
Namespace: EPiServer.Commerce.Reporting.Order.ReportingModels
Assembly: EPiServer.Commerce.Reporting.dll
Version: 14.26.0Syntax
public class LineItemSubscriptionReportingModel : LineItemReportingModelConstructors
LineItemSubscriptionReportingModel()
Declaration
public LineItemSubscriptionReportingModel()Properties
CompletedCyclesCount
Gets or sets the completed cycles count. This property will be auto increased on each new generated sale.
Declaration
public int CompletedCyclesCount { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
CycleLength
Gets or sets the length of the cycle. For example to charge customer monthly, set this value to 1 and CycleMode to Months.
Declaration
public int CycleLength { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
CycleMode
Gets or sets the cycle mode. Cycle modes available are days, weeks, months and years as well as None, Custom1 and Custom2.
Declaration
public PaymentPlanCycle CycleMode { get; set; }Property Value
| Type | Description |
|---|---|
| PaymentPlanCycle |
EndDate
Gets or sets the stop date for the last payment.
Declaration
public Nullable<DateTime> EndDate { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.DateTime> |
IsActive
Gets or sets a value indicating whether this subscription is active.
Declaration
public bool IsActive { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
LastTransactionDate
Gets or sets the last transaction date.
Declaration
public Nullable<DateTime> LastTransactionDate { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.DateTime> |
MaxCyclesCount
Gets or sets the max cycles count. So for instance if you want to charge customer for a year each month, set CycleMode to month, CycleLength to 1 and MaxCyclesCount to 12. Leave at 0 if you never want this cycle to end.
Declaration
public int MaxCyclesCount { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
OrderStatus
Gets or sets the subscription status.
Declaration
public string OrderStatus { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
StartDate
Gets or sets the start date for first payment.
Declaration
public DateTime StartDate { get; set; }Property Value
| Type | Description |
|---|---|
| System.DateTime |
TotalRevenue
Gets or sets the total revenue of the order created by subscription.
Declaration
public Decimal TotalRevenue { get; set; }Property Value
| Type | Description |
|---|---|
| System.Decimal |
Methods
GetSubscriptionCSVHeader()
Declaration
public static string GetSubscriptionCSVHeader()Returns
| Type | Description |
|---|---|
| System.String |
ToString()
Convert this model to string that can be used in a csv file.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| System.String | A string with comma-separated values. |
