Premium.php
This api exposes CiviCRM premiums.
Premiums are used as incentive gifts on contribution pages. Premiums contain "Products" which has a separate api. Use chaining to create a premium and related products in one api call.
Table of Contents
Functions
- civicrm_api3_premium_create() : array<string|int, mixed>
- Save a premium.
- civicrm_api3_premium_get() : array<string|int, mixed>
- Get a premium.
- civicrm_api3_premium_delete() : array<string|int, mixed>
- Delete a premium.
- _civicrm_api3_premium_get_spec() : mixed
- Return field specification specific to get requests.
- _civicrm_api3_premium_create_spec() : mixed
- Return field specification specific to create requests.
Functions
civicrm_api3_premium_create()
Save a premium.
civicrm_api3_premium_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>civicrm_api3_premium_get()
Get a premium.
civicrm_api3_premium_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —Array of retrieved premium property values.
civicrm_api3_premium_delete()
Delete a premium.
civicrm_api3_premium_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —Array of deleted values.
_civicrm_api3_premium_get_spec()
Return field specification specific to get requests.
_civicrm_api3_premium_get_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
_civicrm_api3_premium_create_spec()
Return field specification specific to create requests.
_civicrm_api3_premium_create_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>