How do I add a new subscription?

Using the Interface

Steps:

1. Add new customer 
2. Fill in customer details
3. Click "Create Subscription"
4. Follow the core principles below to set up subscription according to customer's needs

Success!

Core Principles

1. Interval -  this means how often you would like your customer's subscription to be charged. Per day, week, month or year. 
2. Frequency - Determines the frequency of charges depending on the Interval you choose previously. For example, if you want to charge every 7 days, set Interval to "days" and Frequency to "7". If you want it every month, set Interval to "Month" and Frequency to "1".
3. Start Date - Choose when you'd like the schedule to start and the first charge to be made. 
4. End - Determines how and when your customer's subscription will end. 
   1. End never –  keep running until manually removed
   2. End date – keep running up until the specified date which you can specify in new window. 
   3. End amount reached or exceeded - keep running until a certain threshold has been reached or exceeded (a new window will pop up here for you to determine this threshold)
   4. End amount not to exceed - keep running but will not exceed your specified limit (a new window will pop up here for you to determine the total amount). If there's a 'gap' the remainder will not be processed.
   5. Total transactions - keep running until X number of payments have been collected within the Subscription (a new window will pop up here for you to determine transaction amount)
   6. Total amount equals -keep running up until at least the specified total amount is collected (a new window will pop up here for you to determine the total amount). If there's a 'gap' the remainder will be processed at the last transaction. 

Example

This customer will be charged $200 every month, starting 9th August 2018 until a limit of $500 is reached. This means payments will look as follows:

1. 9th August: $200
2. 9th September: $200
3. 9th October: $100

Subscription ends. 

Using the API

Steps:

1. A simple POST /v1/subscriptions

   {
             "amount": "10.00",
             "currency": "AUD",
             "reference": "Custom user reference",
             "description": "Custom user description",
             "customer": {
                 "first_name": "Test_first_name",
                 "last_name": "Test_last_name",
                 "email": "[email protected]",
                 "reference": "CustomReference",
                 "payment_source": {
                     "address_line1": "Testline1",
                     "address_line2": "Testline2",
                     "address_city": "Testcity",
                     "address_state": "Teststate",
                     "address_country": "AU",
                     "address_postcode": "1234",
                     "gateway_id": "55925037556cc23c1ed3773e",
                     "card_name": "Test User",
                     "card_number": "4200000000000000",
                     "expire_month": "01",
                     "expire_year": "17",
                     "card_ccv": "123"
                 }
             },
             "schedule": {
               "frequency": "1",
               "interval": "day",
               "start_date": "2015-07-20",
               "end_date": "2016-07-25T07:35:11Z"
             }
       },

   Success!