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:
- Include any optional amendable fields in the request.
- In the endpoint path, include the subscription ID that you received when you retrieved a list of subscriptions.
- 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:- 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.