-
Notifications
You must be signed in to change notification settings - Fork 66
Sale_Stop
Jacob McConnell edited this page Jun 10, 2014
·
2 revisions
2Checkout's back office API allows you to retrieve sale information. You must specify your API username and password using the the Twocheckout::setCredentials method before calling a method in this class. The Twocheckout_Sale class provides methods to retrieve and update sales and will return a JSON object or array depending on your specification.
##Method
###stop
Use to stop one or all active recurring lineitems on a sale.
####Arguments
- array Array
- Array containing
sale_id
orlineitem_id
parameter in key => value pair.
####Returns
Returns result as JSON or an array depending on your specification.
####Example Usage:
Twocheckout::username('APIuser1817037');
Twocheckout::password('APIpass1817037');
$args = array(
'sale_id' => 4837725728
);
$result = Twocheckout_Sale::stop($args);
####Example Response:
Array
(
[response_code] => OK
[response_message] => Array
(
[0] => 4837725749
)
)
Please feel free to contact 2Checkout directly for assistance with your integration.