Kartra Documentation TECHNICAL DOCUMENTATION

Action: Edit recurring payment subscription status

This will allow you to change the status of a particular recurring payment subscription from one particular lead. The possible statuses are…

  • Active
  • Cancelled
  • Terminated: meaning payment plans where all scheduled payments have already been paid
  • Paused: the subscription is technically active but no further payment will be processed until you “unpause” it back to Active (see below)

A few limitations to keep in mind

  • PayPal subscriptions cannot be edited, since Paypal manages the subscriptions in-house and they do not allow modifications from external sources.
  • Payment subscriptions with status Cancelled or Terminated cannot be changed since they are not technically active anymore.

 

Type Parameters Values
POST cmd* modify_subscription_status
POST subscription_id* integer
POST subscription_status_modification* Posible values are “cancel”, “unpause”, “pause”

* Required fields

Here is an example:

'actions' => [
    '0' => [
        'cmd' => 'modify_subscription_status',
        'subscription_id' => 7373847,
        'subscription_status_modification' => 'pause',
    ]
]

Success message:

{
    "status":"Success",
    "actions":[
        {
            "modify_subscription_status":{
                "status":"Success",
                "message":"Subscription modified",
                "type":"115"
            }
        }
    ]
}

Error Cases:

Type Number Message Cause
248 Subscription doesn’t exist
  • The subscription you are trying to modify does not exist in our database.
274 Wrong status
  • subscription_status_modification is not sent.
  • subscription_status_modification value does not have one of the values “cancel”, “unpause”, “pause”.
284 Paypal transactions cannot be modified
  • Paypal subscriptions can only be cancelled, no other modifications are allowed.
275 Subscriptions cancelled or terminated cannot be updated
  • The subscription you are trying to modify is either cancelled or terminated. These type subscriptions cannot be modified anymore.
252 Subscription already cancelled
  • The subscription you are trying to cancel is already cancelled.
267 Cancellation has failed
  • The cancellation process encountered an unexpected issue.

An example of an error message:

{
  "status": "Error",
  "message": "Subscription doesn't exist",
  "type": 248
}

© 2021 Kartra All Rights Reserved