On This Page

Amending a Subscription

Subscriptions store customer details using a Token Management Service (TMS) token and have an assigned payment plan. Subscriptions consist of this information:
  • Subscription code
  • Subscription name
  • Start date
  • Token Management Service (TMS) token
  • Plan: standard or one-time
IMPORTANT
The subscription information that you can amend depends on the status of the subscription. Note the limitations described in in the paragraphs that follow.
For a
pending
 subscription, you cannot change this information:
  • Customer ID
  • Currency
  • Billing period unit and length
For an
active
 subscription, you cannot change this information:
  • Customer ID
  • Currency
  • Start date (Payment processing time starts at 2:00a.m. in your time zone.)
  • Billing period unit and length
  • Set-up fee
For a
delinquent
,
suspended
,
cancelled
, or
completed
 subscription, you can update only the subscription name and code.
IMPORTANT
When you change the plan ID assigned to a subscription, the first payment is processed immediately. If proration is required after the change, it must be managed outside of the recurring billing service.
Follow these steps to amend a subscription:
  1. Include any optional amendable fields in the request.
  2. In the endpoint path, include the subscription ID that you received when you retrieved a list of subscriptions.
  3. Send the request to the recurring billing endpoint:

    ADDITIONAL INFORMATION

    PATCH https://<
    url_prefix
    >/rbs/v1/subscriptions/{id}

    ADDITIONAL INFORMATION

    Use one of these URL prefixes: