Update Plan Transactions

You use the Update Plan transaction to activate/deactivate Plans associated with recurring payments. When you deactivate a Plan, by setting the active flag to false, you can no longer reference that Plan for use with subscriptions. Existing subscriptions already using the deactivated Plan will continue to use the Plan until the subscription is either modified or completed. You can also reactivate a deactivated Plan by updating the Plan and setting the active flag to true.

Update Plan Request

You must structure an Update Plan request as shown in the following examples. The structure of the request is identical for either an Online or a Batch submission.

<updatePlan>

  <planCode>Plan Reference Code</planCode>

  <active>true or false</active>

</updatePlan>

Example:  Online Update Plan Request

<cnpOnlineRequest version="12.0" xmlns="http://www.vantivcnp.com/schema" merchantId="100">

  <authentication>

    <user>User Name</user>

    <password>password</password>

  </authentication>

  <updatePlan>

    <planCode>Reference_Code</planCode>

    <active>false</active>

  </updatePlan>

</cnpOnlineRequest>

Update Plan Response

An Update Plan response has the following structure. The response message is identical for Online and Batch transactions.

<updatePlanResponse>

  <cnpTxnId>Transaction Id</cnpTxnId>

  <response>Response Code</response>

  <message>Response Message</message>

  <location>Processing Location</location>

  <responseTime>Date and Time in GMT</responseTime>

  <planCode>Plan Reference Code</subscriptionId>

</updatePlanResponse>

Example: Online Update Plan Response

<cnpOnlineResponse version="12.0" xmlns="http://www.vantivcnp.com/schema" response="0" message="Valid Format">

  <updatePlanResponse>

    <cnpTxnId>1100030055</cnpTxnId>

    <response>000</response>

    <message>Approved</message>

    <responseTime>2017-07-11T14:48:46</responseTime>

    <planCode>Reference_Code</planCode>

  </updatePlanResponse>

</cnpOnlineResponse>