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 Plan

Create a plan to define the billing schedule, which includes the amount, frequency, and billing cycles for a subscription. The interval between subscription payments cannot exceed 12 months.

IMPORTANT

If a subscription is to use a one-time plan instead of a standard plan, you create the one-time plan when you create the subscription. The plan details are embedded in the subscription request.

When you create a plan, the system assigns an ID to the plan. Use the plan ID to request these actions:

Creating a subscription

Retrieving a plan

Amending a plan

Activating a plan

Deactivating a plan

Deleting a plan

Follow these steps to create a plan:

Send the request to the recurring billing endpoint:

Production:

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

Test:

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

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

For information about response codes, see

Transaction Response Codes

.

Back to top