API Overview

Recurring Billing Developer Guide
- Recent Revisions to This Document

Introduction to Recurring Billing
- Account Validation (Pre-Authorization)

Subscriptions
- Subscription Prerequisites
- Subscription Statuses
- Zero-Amount Authorizations
- Assigning a Subscription Code
- Subscription ID
- Overriding a Plan
- Creating a Subscription with an Existing Plan
  - Required Fields
  - REST Example: Creating a Subscription with an Existing Plan
- Creating a Subscription with Plan Overrides
  - Required Fields
  - REST Example: Creating a Subscription with Plan Overrides
- Creating a Fully Customized Subscription with a One-Time Plan
  - Required Fields
  - REST Example: Creating a Fully Customized Subscription with a One-Time Plan
- Creating a Follow on Subscription from an Existing Transaction
  - Required Fields
  - REST Example: Creating a Follow on Subscription from an Existing Transaction
- Retrieving Details for Follow on Subscription Creation Based on Existing Transaction
  - REST Examples: Retrieving Details for Follow on Subscription Creation based on Existing Transaction
- 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
  - Amendable Fields
  - REST Example: Switching a Subscription to a Different Plan
- Reactivating a Suspended Subscription
  - REST Examples: Reactivating a Suspended Subscription
- Suspending a Subscription
  - REST Examples: Suspending a Subscription
- Canceling 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

On This Page

REST Example: Creating a Follow on Subscription from an Existing Transaction

This example shows how to create a follow on subscription from an existing transaction.

Request

{
    "subscriptionInformation": {
        "planId":"1619214515",
        "name": "SubNameFOOTPTesting",
        "startDate": "2023-04-15T17:01:42Z"
    }
}

Example Response to a Successful Request

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

Example Response to a Failed Request

{
    "status": "NOT_FOUND",
    "reason": "INVALID_DATA"
}

Back to top