EPPaymentSchedule Type
Contains the recurring payment schedule.
Remarks
This type contains the payment schedule information which the merchant has specified in agreement with the customer. This type is used by the RecurringBilling components.
Please see the "Recurring Gateway Setup and Required Properties" page for further information about the applicable properties for each gateway.
Fields
|
EndDate String |
The end date of the subscription. The default format is "MM/dd/yyyy" and is controlled by DateFormat, or GetSubscriptionStatus. |
|
Frequency String |
The frequency of payments. Possible values are:
Gateway specific values not covered by the above values may also be set. Please refer to RecurringBilling Gateway Setup and Required Properties for more information pertaining to gateway specific values. If FrequencyUnit is applicable to the gateway, this field specifies the length of time between charges. This is used in combination with FrequencyUnit to specify the frequency of the billing. For instance if FrequencyUnit is set to "Days" and Frequency is set to "5", payments will occur every 5 days. |
|
FrequencyUnit String |
The unit of time to be used when calculating the frequency of payments. Possible values are:
|
|
InitialAmount String |
The initial amount to be charged (such as a trial period or setup fee). This amount can vary from RecurAmount. |
|
RecurAmount String |
The amount to be charged on a recurring basis. This amount can vary from InitialAmount. |
|
StartDate String |
The date on which the recurring payments will start processing. This property specifies the start date. The default format is "MM/dd/yyyy" and is controlled by DateFormat, or GetSubscriptionStatus. |
|
TotalPayments int |
The total number of payments. Valid values differ between gateways. See RecurringBilling Gateway Setup and Required Properties for details. |
|
TrialPayments int |
The total number of trial payments. |
Constructors
public EPPaymentSchedule();