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

Creating a Subscription with Plan Overrides

You can create a subscription with a plan overrides.

The start date must be in coordinated universal time (UTC) in this format: YYYY-MM-DDThh:mm:ssZ. The T separates the date and the time. The Z indicates UTC. For example,

2023-08-11T22:47:57Z

indicates August 11, 2023, at 22:47:57 (10:47:57PM). For subscriptions created on the start date, set the time to the current time and day in your time zone.

Fields Specific to This Use Case

These REST API request fields and values are specific to this use case:

subscriptionInformation.name

subscriptionInformation.planId

subscriptionInformation.startDate

subscriptionInformation.originalTransactionId

These REST API request fields are optional:

orderInformation.amountDetails.billingAmount

orderInformation.amountDetails.currency

orderInformation.amountDetails.setupFee

planInformation.billingPeriod.length

planInformation.billingPeriod.unit

planInformation.billingCycles.total

Basic Steps

Follow these steps to create a subscription:

Create the request with the required API fields.

Send the request to one of these endpoints:

Production:

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

Test:

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

Verify the response messages to make sure that the request was successful. A 200-level HTTP response code indicates success.

See

Transaction Response Codes

.

Back to top