0

I need to stop a recurring sale.

The sales always have one item only.

Looking at the documentation for this API call: http://www.2checkout.com/documentation/api/sales/stop-lineitem-recurring/ , it requires a lineItemId.

I dont see any lineItemId in the INS ORDER_CREATED and RECURRING_INSTALLMENT_SUCCESS messages.

Where do I get this field from? I'm assuming its the invoice id which is to be used. Is it correct?

Zaki
  • 6,997
  • 6
  • 37
  • 53

1 Answers1

2

All 2Checkout sales have a sale_id, and invoice_id and at least one lineitem_id. Recurring sales create a new invoice on each recurring instalment so the sales/detail_sale API call may return multiple invoices. The sale_id can have many invoice_id's and each invoice_id can have many linitems_id's.

If you need to stop the recurring billing on a sale, you need to stop the recurring billing an each active recurring lineitem. The lineitem_id is changed on each new invoice on a recurring sale so when making the stop_lineitem_recurring call it is necessary to use the lineitem_ids from the most recently billed invoice. To make it easier, you can use the 2Checkout client library for the language you are using as each library provides you with a method to stop all recurring lineitems on a sale using the sale ID (order number).

Craig-2Checkout
  • 741
  • 5
  • 7
  • If I dont use the client library, I have to use the sales/detail API call first to get the lineItemIds and then call the stop-lineitem-recurring API for that lineItemId? – Zaki Jul 22 '13 at 05:47
  • 1
    Yes, the lineitem_id's are not returned through INS messages so you would need to take the most recent invoice_id from the INS message, make a detail_sale call using the invoice_id to retrieve the lineitem_id and then make the stop_lineitem_recurring call. – Craig-2Checkout Jul 22 '13 at 14:29
  • Thanks! (15 chars padding). – Zaki Jul 22 '13 at 15:18