This will allow retrieve all payment subscriptions within the refund period.
Type | Parameters | Values |
POST | cmd* | retrieve_subscriptions_from_lead |
* Required field Here is an example:
'lead' => [
'email' => '[email protected]'
],
'actions' => [
'0' => [
'cmd' => 'retrieve_subscriptions_from_lead'
]
]Here are the results returned by the request:
Parameters | Values |
subscriptions_list | String (JSON encoded array containing the payment subscriptions for the lead, empty array if no payment subscriptions) |
JSON parameters | Values |
subscription_id | integer A unique numeric identifier for the subscription id. |
lead_id | integer Id for the lead linked to the transaction. |
lead_email | string Email of the lead linked to the subscription. |
subscription_status | string The subscription status. Possible values: 'Active', 'Terminated', 'Cancelled', 'Paused' |
Example of the returned JSON array:
{
"retrieve_subscriptions_from_lead":{
"subscriptions_list":[
{
"subscription_id":"48110",
"lead_id":"4174086",
"lead_email":"[email protected]",
"subscription_status":"Active"
},
{
"subscription_id":"48112",
"lead_id":"4174086",
"lead_email":"[email protected]",
"subscription_status":"Paused"
},
},
}
}