GetProfile Method

This method returns the requested profile.

Syntax

recurringpayments.getProfile(profileId, [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

Use this method to retrieve the specified recurring payments profile. This method takes a ProfileId parameter which specifies which profile the class will request from PayPal.

The details of the profile will be populated into various properties such as BillingDetails and CyclesCompleted.