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

Construct Your Subscription Creation Script

For each subscription record that you exported from your former subscription provider, your script must submit an API request to create a new Recurring Billing subscription in the

Cybersource

system.

For each subscription, instructions in your script must:

Create the subscription creation request message with the required REST API fields.

ADDITIONAL INFORMATION

Follow these guidelines:

Requirements for the Subscription Creation Script

Additional API Field Required for Any Credit or Debit Card Subscription

Additional API Field Required for a Diners or Discover Card

ADDITIONAL INFORMATION

For reference information to help you to construct a request message through your script, see these topics:

Using the Interactive REST API Reference

Creating a Subscription with a One-Time Plan

Creating a Subscription with an Existing Plan

Creating a Subscription with Plan Overrides

Send the message to one of these endpoints:

Production:

POST https://api.cybersource.com/rbs/v1/subscriptions

Test:

POST https://apitest.cybersource.com/rbs/v1/subscriptions

Check the response messages to verify that the request was successful.

ADDITIONAL INFORMATION

A 200-level HTTP response code indicates success. See the

Transaction Response Codes

.

Write the request and response information to the log file for troubleshooting and verification purposes.

For transaction errors, perform error handling and retry logic when appropriate.

Back to top