Creating a Follow on Subscription from an Existing Transaction
You can create a subscription using an existing successful transaction by specifying its
request ID in the path. This method eliminates the need to provide a customer
token.
You can use an existing or one-time plan.
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:57 p.m.).
For subscriptions created on the start date, set the
time to the current time and day in your time zone.Follow these steps to create a subscription:
- Create the request with the required API fields.
- Send the request to one of these endpoints:
ADDITIONAL INFORMATION
Production:POST https://api.cybersource.com/rbs/v1/subscriptions/follow-ons/{requestId}Test:POST https://apitest.cybersource.test.com/rbs/v1/subscriptions/follow-ons/{requestId} - Verify the responses to make sure that the request was successful. A 200-level HTTP response code indicates success.See theTransaction Response Codes.
Required Fields
These fields are required for creating a subscription from an existing
transaction:
- subscriptionInformation.name
- subscriptionInformation.startDate
This field is required for using an existing plan:
- subscriptionInformation.planId
These fields are required for using a one-time plan:
- orderInformation.amountDetails.billingAmount
- orderInformation.amountDetails.currency
- orderInformation.amountDetails.setupFee
- planInformation.billingPeriod.length
- planInformation.billingPeriod.unit
Related Information
REST Example: Creating a Follow on Subscription from an Existing Transaction
Request
12345{"subscriptionInformation": { "planId":"1619214515", "name": "SubNameFOOTPTesting", "startDate": "2023-04-15T17:01:42Z" }}
Example Response to a Successful Request
1234567891011121314151617181920{"_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
12{"status": "NOT_FOUND", "reason": "INVALID_DATA"}