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

Additional Features

VISA Platform Connect: Specifications and Conditions for Resellers/Partners

On This Page

Required Fields

These fields are required for creating a subscription with an existing plan:

paymentInformation.customer.id
subscriptionInformation.name
subscriptionInformation.planId: Required when you are using a standard plan.
subscriptionInformation.startDate

Optional Field

These fields are optional:

subscriptionInformation.originalTransactionId: Including this field ensures better authorization rates and Strong Customer Authentication (SCA) compliance where necessary.
subscriptionInformation.code
clientReferenceInformation.code: Merchant reference number.

Related Information

API field reference guide for the REST API

Back to top