GetByID
array CSaleRecurring::GetByID( int ID );
Method returns parameters on extension with ID. Non-static method.
Call parameters
Parameter | Description |
---|---|
ID | Record ID with extension data. |
Returned values
Method returns an associative array with extension parameters with the following keys:
- ID - record ID;
- USER_ID - user ID;
- MODULE - module with extended product;
- PRODUCT_ID - extended product ID;
- PRODUCT_NAME - extended product name;
- PRODUCT_URL - link to extended product;
- RECUR_SCHEME_TYPE - type of payment period;
- RECUR_SCHEME_LENGTH - payment period length;
- WITHOUT_ORDER - "Auto extend recurring subscription";
- ORDER_ID - base order ID for extension;
- CANCELED - flag for cancelling the extension;
- DESCRIPTION - description;
- CALLBACK_FUNC - callback function for updating extension parameters;
- REMAINING_ATTEMPTS - number of remaining attempts for extension;
- SUCCESS_PAYMENT - successful extension;
- CANCELED_REASON - reason for cancellation;
- DATE_CANCELED - date of cancellation;
- PRIOR_DATE - date of the last extension;
- NEXT_DATE - date of the next extension;
- TIMESTAMP_X - last record update timestamp.
Note: method's result is cached within a single page. That's why repeated method calls do not lead to additional queries to database.
© «Bitrix24», 2001-2024