Function __global->add_usergroup_subscription
Definitions
sources/ecommerce2.php
- Add a usergroup subscription.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: int
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $title | SHORT_TEXT | required parameter | N/A | N/A | The title |
| $description | LONG_TEXT | required parameter | N/A | N/A | The description |
| $price | REAL | required parameter | N/A | N/A | The price |
| $tax_code | ID_TEXT | required parameter | N/A | N/A | The tax code |
| $length | integer | required parameter | N/A | N/A | The length |
| $length_units | SHORT_TEXT | required parameter | N/A | N/A | The units for the length |
| $auto_recur | BINARY | required parameter | N/A | N/A | Auto-recur |
| $group_id | GROUP | required parameter | N/A | N/A | The usergroup that purchasing gains membership to |
| $uses_primary | BINARY | required parameter | N/A | N/A | Whether this is applied to primary usergroup membership |
| $enabled | BINARY | required parameter | N/A | N/A | Whether this is currently enabled |
| $mail_start | ?LONG_TEXT | required parameter | N/A | N/A | The text of the e-mail to send out when a subscription is start (null: default) |
| $mail_end | ?LONG_TEXT | required parameter | N/A | N/A | The text of the e-mail to send out when a subscription is ended (null: default) |
| $mail_uhoh | ?LONG_TEXT | required parameter | N/A | N/A | The text of the e-mail to send out when a subscription cannot be renewed because the subproduct is gone (null: default) |
| $mails | array | [] | N/A | N/A | Other e-mails to send |
Return
- The ID
- Type: AUTO_LINK
- Set: N/A
- Range: N/A