Language

2Checkout Documentation

Stop

You must specify your API username and password using the twocheckout.Api.credentials method before calling a method in this class.

Method

stop

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

Arguments

  • None
    • Can only be called on a sale or lineitem instance.

Returns

Returns result as a Python object.

Example Usage:

twocheckout.Api.credentials({'username':'APIuser1817037', 'password':'APIpass1817037'})

params = {
    'sale_id': 4834917619
    }

sale = twocheckout.Sale.find(params)

result = sale.stop()

//Or call stop on a lineitem
invoice = sale.invoices[0]
lineitem = invoice.lineitems[0]

result = lineitem.stop();

Example Response:

{
    'response_code': 'OK', 
    'response_message': '3 lineitems stopped successfully'
}