Documentation

Update

int
CSaleRecurring::Update(
	int ID,
	array arFields
);

Method updates parameters for subscription renewal parameters according to parameters from arFields array. Non-static method.

Call parameters

ParameterDescription
ID Code for updated entry for subscription renewal.
arFields Associative array with new entry parameters with subscription renewal keys:
  • USER_ID - user ID;
  • MODULE - module with renewed product;
  • PRODUCT_ID - renewed product ID;
  • PRODUCT_NAME - renewed product name;
  • PRODUCT_URL - link to renewed product;
  • RECUR_SCHEME_TYPE - type of payment period;
  • RECUR_SCHEME_LENGTH - payment period length;
  • WITHOUT_ORDER - "Renewal without ordering" flag;
  • ORDER_ID - base order ID for renewal;
  • CANCELED - canceled renewal flag;
  • DESCRIPTION - description;
  • CALLBACK_FUNC - callback function for renewal parameter update;
  • REMAINING_ATTEMPTS - number of remaining attempts for renewal;
  • SUCCESS_PAYMENT - successful renewal;
  • CANCELED_REASON - cancellation reason;
  • DATE_CANCELED - date of cancellation;
  • PRIOR_DATE - date of the last renewal;
  • NEXT_DATE - date of next renewal;

Returned values

Method returns an updated entry code or False otherwise in case of an error.



© «Bitrix24», 2001-2024