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:
  1. Include any optional fields.
  2. In the endpoint path, include the plan ID that you received when you retrieved a list of plans.
  3. 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: