API Overview

Recurring Billing Developer Guide
- Recent Revisions to This Document

Introduction to Recurring Billing
- Account Validation (Pre-Authorization)

Plans
- Plan Statuses
- Assigning a Plan Code
- Creating a Plan
- Retrieving a List of Plans
- Retrieving a Plan
- Retrieving a Plan Code
- Amending a Plan
- Activating a Plan
- Deactivating a Plan
- Deleting a Plan

Subscriptions
- Subscription Prerequisites
- Subscription Statuses
- Zero-Amount Authorizations
- Assigning a Subscription Code
- Subscription ID
- Overriding a Plan
- Creating a Subscription with an Existing Plan
- Creating a Subscription with Plan Overrides
- Creating a Fully Customized Subscription with a One-Time Plan
- Creating a Follow-on Subscription from an Existing Transaction
- Retrieving the Details of a Follow-on Subscription Based on an Existing Transaction
- Retrieving a List of Subscriptions
- Retrieving a Subscription
- Retrieving the Next Subscription Code
- Amending a Subscription
- Reactivating a Suspended Subscription
- Suspending a Subscription
- Canceling a Subscription
- Retrieving a List of Payments in a Subscription
  - REST Examples: Retrieving a List of Payments in a Subscription
- Skipping or Restoring Payments Within a Subscription
  - REST Example: Skipping or Restoring a Payment in a Subscription

Additional Features

Response Status Codes

On This Page

Required Fields

These fields are required for creating a subscription with subscription one-time plan:

orderInformation.amountDetails.billingAmount
orderInformation.amountDetails.currency
orderInformation.amountDetails.setupFee
paymentInformation.customer.id
planInformation.billingPeriod.length
planInformation.billingPeriod.unit
subscriptionInformation.name
subscriptionInformation.startDate

Optional Field

subscriptionInformation.originalTransactionId: Network token identifying the transaction that initialized the subscription. Including this field ensures better authorization rates and Strong Customer Authentication (SCA) compliance where necessary.; This value is returned in the Payments response as
processorInformation.networkTransactionId
.; For EFTPOS cards, a network token is not generated. In this case, provide the transaction request ID or use 0.
subscriptionInformation.code
clientReferenceInformation.code: Merchant reference number.

Back to top