Try our conversational search powered by Generative AI!

AI OnAI Off

Interface IPaymentPlan

Represents a payment plan in the system.

Inherited Members
Namespace: EPiServer.Commerce.Order
Assembly: Mediachase.Commerce.dll
Version: 12.17.2
Syntax
public interface IPaymentPlan : IOrderGroup, IExtendedProperties

Properties

CompletedCyclesCount

Gets or sets the completed cycles count. This property will be auto increased on each new generated sale.

Declaration
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
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
PaymentPlanCycle CycleMode { get; set; }
Property Value
Type Description
PaymentPlanCycle

EndDate

Gets or sets the stop date for the last payment.

Declaration
DateTime? EndDate { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

IsActive

Gets or sets a value indicating whether this Payment Plan is active.

Declaration
bool IsActive { get; set; }
Property Value
Type Description
System.Boolean

LastTransactionDate

Gets or sets the last transaction date.

Declaration
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
int MaxCyclesCount { get; set; }
Property Value
Type Description
System.Int32

StartDate

Gets or sets the start date for first payment.

Declaration
DateTime StartDate { get; set; }
Property Value
Type Description
System.DateTime

Extension Methods