Add a subscription

There are three ways to create a Subscription within the Paydock Dashboard, which are detailed below. By default, the first charge on the subscription is scheduled for 11:30 AM UTC of the current day. If you create a subscription earlier, the charge will happen at this particular time, so do not worry if you do not see an immediate payment. If a subscription is created after 11:30 AM UTC, the charge will be made right away. If you want the charge to occur at a specific time, you can mention it in the "start_date" when creating a subscription through the API.

To ensure the subscription meets your needs, please consider these 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 chose. For example, if you want to charge every 5 days, set Interval to "days" and Frequency to "5".
  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. 
    3. End amount reached or exceeded - keep running until a certain financial threshold has been reached or exceeded.
    4. End amount not to exceed - keep running but will not exceed your specified limit. If there's a 'gap' the remainder will not be processed.
    5. Total transactions - keep running until a specified number of payments have been collected.
    6. Total amount equals - keep running up until at least the specified total amount is collected. If there's a shortfall the remainder will be processed at the last transaction.

The three ways to create a new subscription within your Dashboardare:

Add the Subscription for an existing Customer:

  1. Go to Subscriptions.
  2. Choose Add new tab.
  3. Fill in customer details, schedule and payment information.
  4. Click Add Subscription.

Create the Customer along with the Subscription, like so:

  1. Go to Customers.
  2. Click on Actions next to the customer in question.
  3. Choose Add Subscription.
  4. Fill in the subscription details.
  5. Click Add Subscription.

Add a Subscription from the Charges section, like

  1. Go to Charges;
  2. Click on Add new;
  3. Choose Subscription in the Select Payment Type dropdown;
  4. Fill in customer details, schedule and payment information;
  5. Click Create Subscription.

Using the API

Creating Subscriptions via the API is simple, using 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": "Test@test.com",
               "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"
           }
     },
	

A more detailed overview of the subscription feature can be found in this video:

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us