API Methods: Recurring Sale Parameters

Using GetURL /SaleChargeToken /CreateSale

To create a recurring sale with these methods, you must first set the CreateRecurringSale parameter to true. The following parameters are used to configure the recurring payment schedule.

Parameters

• 'CreateRecurringSale' (boolean)
  • Set to true to indicate the creation of a recurring sale.
  
  
• 'SaleType' (integer)
  • For recurring sales, the transaction must be set to "pending payment". Use the value 2.
  
  
• 'RecurringSaleCycle' (integer)
  • Specifies the time unit for the billing cycle.
    • 1 = Day
    • 2 = Week
    • 3 = Month
    
    
• RecurringSaleDay (integer)
  • The day of the month on which the charge should occur (e.g., 15 for the 15th).
  • Note: This parameter is only relevant for monthly cycles (RecurringSaleCycle = 3). The valid range is 1-28.
  
  
• RecurringSaleStep (integer)
  • Defines the interval between charges, based on the RecurringSaleCycle. For example, a RecurringSaleStep of 2 with a RecurringSaleCycle of 3 (Month) would result in a charge every two months.
  • Default: 1
  
  
• RecurringSaleCount (integer)
  • The total number of payments in the recurring series.
  • Set to 0 for an indefinite (non-stop) recurring payment.
  
  
• RecurringSaleStartDate (date)
  • The date to start the recurring payment cycle (e.g., YYYY-MM-DD).
  • Leave this parameter empty to start the cycle on the day of its creation.
  
  
• RecurringSaleAutocharge (boolean)
  • Set to true to automatically charge the customer for each payment in the recurring series.

Using Direct Payments (ChargeSimple with CreateSale )

To process a recurring sale using the ChargeSimple direct payment method, use the following specific parameter values.