Kartra Documentation Technical Documentation for Kartra

Action: Search recurring payment subscription

This will allow you to search for a recurring payment subscription inside Kartra, and to verify whether it exists or not.

Type Parameters Values
POST cmd* search_subscription
POST transaction_internal_subscription_id* integer

* Required fields

Here is an example:

'actions' => [
    '0' => [
        'cmd' => 'search_subscription',
        'transaction_internal_subscription_id' => 94314
    ]
]

Success message:

{
  "status": "Success",
  "message": "Subscription exists"
}

Error Cases:

Type Number Message Cause
248 Subscription doesn’t exist
  • The subscription you are trying to find does not exist in our database.

An example of an error message:

{
  "status": "Error",
  "message": "Subscription doesn't exist",
  "type": 248
}
Was this article helpful?
YesNo

© 2024 Kartra All Rights Reserved