API Overview

Recurring Billing Subscription Data Migration Guide
- Recent Revisions to This Document
- VISA Platform Connect: Specifications and Conditions for Resellers/Partners

Introduction to Migrating Subscription Data to Cybersource Recurring Billing
- Migration Flow
- Migration Limitations
- Migration Prerequisites

Task 1: Enable Recurring Billing in Your Cybersource Account

Task 2: Integrate with the Cybersource API

Task 3: Export Current Subscriptions to a File

Task 4: Create New Subscriptions
- Requirements for the Subscription Creation Script
- Additional Fields Required for Card Subscriptions
  - Additional API Field Required for Any Credit or Debit Card Subscription
  - Additional API Field Required for a Diners or Discover Card
- Obtaining Additional Values Required for Card Subscriptions
  - Retrieve Original Subscription Data from the Cybersource TMS
  - Retrieve Original Subscription Data from the Original Provider
  - When Original Subscription Data Cannot Be Retrieved
- Construct Your Subscription Creation Script

Task 5: Validate the New Subscriptions in the Cybersource System
- Use the Business Center to Validate Migrated Subscriptions
- Use the REST API to Validate Migrated Subscriptions

Finalize the Migration

Reference Information
- Using the Interactive REST API Reference
  - Build a Request to Create a Recurring Billing Plan
  - Build a Request to Create a Recurring Billing Subscription
- Creating a Subscription with a One-Time Plan
  - Required and Optional Fields
  - REST Example: Create a Subscription with a One-Time Plan
- Creating a Subscription with an Existing Plan
  - Required and Optional Fields
  - REST Example: Create a Subscription with an Existing Plan
- Creating a Subscription with Plan Overrides
  - Required and Optional Fields
  - REST Example: Create a Subscription with Plan Overrides

On This Page

Required and Optional Fields

These fields are required for creating a subscription with plan overrides:

paymentInformation.customer.id
subscriptionInformation.name
subscriptionInformation.planId
subscriptionInformation.startDate

Optional Fields

orderInformation.amountDetails.billingAmount: Amount charged during the billing period.
orderInformation.amountDetails.currency
orderInformation.amountDetails.setupFee: The subscription set-up fee charged by the merchant.
planInformation.billingCycles.total
planInformation.billingPeriod.length
planInformation.billingPeriod.unit
subscriptionInformation.originalTransactionId: Required to create any credit or debit card subscription.; Including this field ensures better authorization rates and Strong Customer Authentication (SCA) compliance where necessary.
subscriptionInformation.originalTransactionAuthorizedAmount: Additional required field for a Diners or Discover card.

Related Information

API field reference guide for the REST API

Back to top