GetSubscriptionStatus Method

Retrieves the status of a recurring payment subscription.

Syntax

recurringbilling.getSubscriptionStatus(subscriptionId, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method retrieves the current status of the recurring payment subscription specified via SubscriptionId. SubscriptionDetails will be populated with the details about the subscription.