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

REST Example: Create a Subscription with an Existing Plan

This example creates a subscription that uses an existing plan.

Request

{
  "subscriptionInformation": {
    "planId": "6868912495476705603955",
    "name": "Subscription with plan id",
    "startDate": "2025-08-10",
    "originalTransactionId": "123456789",
    "originalTransactionAuthorizedAmount": "0.00"
  },
  "paymentInformation": {
    "customer": {
      "id": "C24F5921EB870D99E053AF598E0A4105"
    }
  }
}

Example Response to a Successful Request

{
    "_links": {
        "self": {
            "href": "/rbs/v1/subscriptions/1619214690",
            "method": "GET"
        },
        "update": {
            "href": "/rbs/v1/subscriptions/1619214690",
            "method": "PATCH"
        },
        "cancel": {
            "href": "/rbs/v1/subscriptions/1619214690/cancel",
            "method": "POST"
        }
    },
    "id": "1619214690",
    "status": "COMPLETED",
    "subscriptionInformation": {
        "code": "AWC-47",
        "status": "PENDING"
    }
}

Example Response to a Failed Request

{
    "status": "INVALID_REQUEST",
    "reason": "INVALID_DATA",
    "message": "One or more fields in the request contains invalid data.",
    "details": [
        {
            "field": "subscriptionInformation.startDate",
            "reason": "INVALID_DATA"
        }
    ]
}

Back to top