API Overview

Recurring Billing Developer Guide
- Recent Revisions to This Document

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

Subscriptions
- Subscription Prerequisites
- Subscription Statuses
- Zero Amount Authorizations
- Assigning a Subscription Code
- Subscription ID
- Overriding a Plan
- Creating a Subscription
  - Required Fields for Creating a Subscription
  - Optional Fields for Creating a Subscription
  - REST Examples: Creating a Subscription
- Retrieving a List of Subscriptions
  - REST Examples: Retrieving a List of Subscriptions
- Retrieving a Subscription
  - REST Examples: Retrieving a Subscription
- Retrieving the Next Subscription Code
  - REST Examples: Retrieving the Next Subscription Code
- Amending a Subscription
  - REST Examples: Amending a Subscription
- Re-activating a Suspended Subscription
  - REST Examples: Reactivating a Suspended Subscription
- Suspending a Subscription
  - REST Examples: Suspending a Subscription
- Cancelling a Subscription
  - REST Examples: 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

Optional Fields for Creating a Subscription

These fields are optional for creating a subscription:

clientReferenceInformation.code
clientReferenceInformation.partner.developerId
clientReferenceInformation.partner.solutionId
clientReferenceInformation.transactionId
orderInformation.amountDetails.billingAmount
orderInformation.amountDetails.currency
orderInformation.amountDetails.setupFee
planInformation.billingPeriod.billingCycles: Required for a plan with a defined plan period.
planInformation.billingPeriod.length
planInformation.billingPeriod.unit
planInformation.description
planInformation.name
planInformation.status
subscriptionInformation.code

Back to top