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 Examples: Retrieving Details for Follow on Subscription Creation based on Existing Transaction

Successful Response

{
  "_links": {
    "self":  {
	"href": "rbs/v1/subscriptions/follow-ons/7216512479796378604957",
	"method": "GET"
	},
	"create":  {
	"href": "rbs/v1/subscriptions/follow-ons/7216512479796378604957",
	"method": "POST"
	}
  },
  "buyerInformation": {
    "merchantCustomerId": "1234",
    "email": ""
  },
  "paymentInstrument": {
    "card": {
      "number": "411111XXXXXX1111",
      "expirationMonth": "11",
      "expirationYear": "2037",
      "type": "001"
    },
    "billTo": {
      "firstName": "John",
      "lastName": "Doe",
      "address1": "123 Street",
      "locality": "Bellevue",
      "administrativeArea": "AL",
      "postalCode": "12345",
      "email": "[email protected]",
      "country": "US"
    }
  },
  "shippingAddress": {
    "shipTo": {
      "firstName": "John",
      "lastName": "Doe",
      "address1": "123 Street",
      "locality": "Bellevue",
      "administrativeArea": "AL",
      "postalCode": "12345",
      "country": "US"
    }
  }
}

Error Response to a Failed Request

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

Back to top