On This Page
REST API
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:
ADDITIONAL INFORMATION
PATCH https://<url_prefix>/rbs/v1/plans/{id}ADDITIONAL INFORMATION
Use one of these URL prefixes:- Test:apitest.cybersource.com
- Production:api.cybersource.com
- Production in India:api.in.cybersource.com
- 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.