Bitrix Site Manager

CSaleRecurring::CancelRecurring

bool
CSaleRecurring::CancelRecurring(
 int ID
 string val[,
 string description = ""]
);

The method CancelRecurring cancels the subscription renewal identified by the ID.

Parameters

ParameterDescription
ID The ID of the record with information about a renewal.
val If "Y", the subscription is cancelled, "N" - the subscription is restored.
description The reason of the subscription cancellation.

Return Values

The method returns the ID of the cancelled record on success, or false otherwise.