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

Amending a Plan

Amend a plan by entering one of two values in the

processingInformation.subscriptionBillingOptions.applyTo

field. Possible values:

ALL

: change is applied to all subscriptions (existing and new).

NEW

(default): change is applied to new subscriptions only.

You can also make changes to individual subscriptions. See Amending a Subscription.

For a draft
plan, you can amend all plan information.

For an active
plan, you can amend only the information in these fields:

planInformation.billingPeriod

planInformation.billingCycles

orderInformation.amountDetails.currency

IMPORTANT

You cannot amend an inactive plan. To make changes, move the plan to active or draft status.

Follow these steps to amend a plan:

Include any optional fields.

In the endpoint path, include the plan ID that you received when you retrieved a list of plans.

Send the request to the Recurring Billing endpoint:

Production:

PATCH https://api.cybersource.com/rbs/v1/plans/{id}

Test:

PATCH https://apitest.cybersource.test.com/rbs/v1/plans/{id}

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