\Commerce\RecurringSales
Templating
Global Functions
Website
\Components\Website\Designs \Components\Website\Media \Components\Website\Pages \Components\Website\Pages\Forms \Components\Website\Posts \Components\Website\Posts\Categories
Customers
\Components\Customers\Contacts \Components\Customers\Contacts\Relationships \Components\Customers\Contacts\Relationships\Types \Components\Customers\Groups
Marketing
\Components\Marketing\EmailMarketing \Components\Marketing\Events \Components\Marketing\Events\Attendees \Components\Marketing\Events\Categories \Components\Marketing\Events\Locations
Commerce
\Components\Commerce\Carts \Components\Commerce\Carts\Current \Components\Commerce\Configuration\PaymentMethods \Components\Commerce\Configuration\ShippingMethods \Components\Commerce\Discounts \Components\Commerce\Products \Components\Commerce\Products\Brands \Components\Commerce\Products\Categories \Components\Commerce\Products\Inventory \Components\Commerce\Sales \Components\Commerce\Sales\Items \Components\Commerce\Sales\Receipts \Components\Commerce\Sales\Receipts\Allocations
Settings
\Components\Settings\Administrators \Components\Settings\CustomFields \Components\Settings\Domains
Other Apps
\Components\Website\Comments \Components\Commerce\Affiliates \Components\Commerce\Affiliates\Administrators \Components\Commerce\Affiliates\Commissions \Components\Commerce\Affiliates\Payments \Components\Commerce\RecurringSales \Components\Commerce\RecurringSales\StoredCards
Framework
\Framework\Caching \Framework\Data\Util \Framework\DOM\CurrentContext \Framework\HTML\Converters \Framework\HTTP\Cookies \Framework\HTTP\Redirection \Framework\HTTP\Request \Framework\HTTP\Session \Framework\HTTP\UserAgent \Framework\I18N\CompanyTypes \Framework\I18N\Countries \Framework\I18N\Languages \Framework\Network\GeoIP

RecurringSales

Use this API to create, update and delete recurring sales for subscriptions.

Methods

Invoke via \Components\Commerce\RecurringSales::method()
Click a method name to copy it.
- ` string cartRecurringMessage() `
When recurring products exist in the cart, this function returns a string that can be used as a label underneath a summary of the order to describe the recurring products.
Return
string
- ` bool delete($iRecurringSaleId, $bDeleteMedia) `
Deletes a record from the database
Parameters:
- $iRecurringSaleId
int unsigned
A record's recurring_sale_id
- $bDeleteMedia
mixed
Return
Returns true if record existed and was deleted, otherwise false
- ` array get($iRecurringSaleId) `
Gets a record from the database
Parameters:
- $iRecurringSaleId
int unsigned
A record's recurring_sale_id
Return
RecurringSales
- ` array getAll($arrQuery) `
Return a set of records from the database
Parameters:
- $arrQuery
mixed
Return
Array of RecurringSales
- ` array getAllForContact($iContactId, $arrQuery) `
Returns all recurring sales for a contact
Parameters:
- $iContactId
mixed
- $arrQuery
mixed
Return
Array of RecurringSales
- ` mixed getColumn($iRecurringSaleId, $strColumn) `
Gets a single field from a record
Parameters:
- $iRecurringSaleId
int unsigned
A record's recurring_sale_id
- $strColumn
mixed
Return
mixed
- ` int getCount($arrFilter) `
Returns the number of records in the database (matching the filter if specified)
Parameters:
- $arrFilter
mixed
Return
int
- ` string renderInterval($arrRecurring) `
Renders the interval for a recurring sale in a human-readable format
Parameters:
- $arrRecurring
mixed
Return
string
- ` string|int save($arrEntity) `
Saves a record into the database
Parameters:
- $arrEntity
mixed
Return
string|int
- ` void saveColumn($iRecurringSaleId, $strColumn, $strValue) `
Saves a specific column of a row into a database
Parameters:
- $iRecurringSaleId
int unsigned
A record's recurring_sale_id
- $strColumn
mixed
- $strValue
mixed
- ` array search($strSearch, $arrQuery) `
Performs a search
Parameters:
- $strSearch
mixed
- $arrQuery
mixed
Return
Array of RecurringSales that match the search query.

Database Fields

The following fields are used when retrieving and saving entities:
- `recurring_sale_id`
int unsigned (10)
- `recurring_sale_creation_datetime`
datetime
- `recurring_sale_terminated_datetime`
datetime
- `recurring_sale_created_by_sale_item`
int unsigned (10)
- `recurring_sale_status`
Default value: active
- `recurring_sale_schedule_interval_number`
0 or 1
Default value: 1
- `recurring_sale_schedule_interval`
- `recurring_sale_total`
decimal unsigned (10,4)
- `recurring_sale_currency_id`
string (3)
Default value: AUD
- `recurring_sale_country_id`
string (3)
Default value: AUS
- `administrator_id`
int (11)
- `recurring_sale_comments`
string (65535)
- `contact_id`
int (10)
- `contact_type`
Default value: Individual
- `contact_company`
string (127)
- `contact_first_name`
string (63)
- `contact_last_name`
string (63)
- `contact_email`
string (127)
- `payment_method_id`
int (11)
- `shipping_method_id`
int (11)
- `shipping_method_data`
string (65535)
- `sale_surcharge_data`
string (16777215)
- `affiliate_id`
int unsigned (10)
- `recurring_sale_run_total`
decimal unsigned (10,4)
- `recurring_sale_run_balance`
decimal (10,4)
- `recurring_sale_run_count`
int unsigned (10)
- `recurring_sale_run_limit`
int unsigned (10)
- `recurring_sale_run_last`
datetime
- `recurring_sale_run_next`
datetime
- `recurring_sale_run_next_override`
datetime