API Overview

Recurring Billing Developer Guide
- Recent Revisions to This Document

Introduction to Recurring Billing
- Prerequisites
- Account Validation (Pre-Authorization)
- Supported Processors
- REST API

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 Details for Follow on Subscription Creation Based on 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

Additional Features
- System Retry Logic
- Merchant-Initiated Transactions
- Customer Notifications
- Decision Manager Integration
- Account Updater Integration

Testing

VISA Platform Connect: Specifications and Conditions for Resellers/Partners

Required Fields

These fields are required for creating a subscription from an existing transaction:

subscriptionInformation.name
subscriptionInformation.startDate

This field is required for using an existing plan:

subscriptionInformation.planId

These fields are required for using a one-time plan:

orderInformation.amountDetails.billingAmount
orderInformation.amountDetails.currency
orderInformation.amountDetails.setupFee
planInformation.billingPeriod.length
planInformation.billingPeriod.unit

Related Information

API field reference guide for the REST API