ContributionProduct.php
This api exposes CiviCRM premium products attached to contributions.
Premiums are used as incentive gifts on contribution pages. Use chaining to create a premium and related products in one api call.
Table of Contents
Functions
- civicrm_api3_contribution_product_create() : array<string|int, mixed>
- Save a contribution product.
- civicrm_api3_contribution_product_get() : array<string|int, mixed>
- Get a contribution product.
- civicrm_api3_contribution_product_delete() : array<string|int, mixed>
- Delete a contribution product.
Functions
civicrm_api3_contribution_product_create()
Save a contribution product.
civicrm_api3_contribution_product_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_contribution_product_get()
Get a contribution product.
civicrm_api3_contribution_product_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 product property values.
civicrm_api3_contribution_product_delete()
Delete a contribution product.
civicrm_api3_contribution_product_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.