Language

2Checkout Documentation

Stop

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 an Array or JSON response depending on your format specification.

Method

stop

Use to stop one or all active recurring lineitems on a sale.

Arguments

  • Array containing sale_id* or lineitem_id parameter in key => value pair.

Returns

Returns an Array or JSON depending on your format 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
        )
)