3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
13 * This api exposes CiviCRM recurring contributions.
15 * @package CiviCRM_APIv3
19 * Create or update a ContributionRecur.
21 * @param array $params
22 * Array per getfields metadata.
27 function civicrm_api3_contribution_recur_create($params) {
28 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'ContributionRecur');
32 * Adjust Metadata for Create action.
34 * The metadata is used for setting defaults, documentation & validation.
36 * @param array $params
37 * Array of parameters determined by getfields.
39 function _civicrm_api3_contribution_recur_create_spec(&$params) {
40 $params['contact_id']['api.required'] = 1;
41 $params['create_date']['api.default'] = 'now';
42 $params['frequency_interval']['api.required'] = 1;
43 $params['amount']['api.required'] = 1;
44 $params['start_date']['api.default'] = 'now';
45 $params['modified_date']['api.default'] = 'now';
49 * Returns array of contribution_recurs matching a set of one or more group properties.
51 * @param array $params
52 * Array of properties. If empty, all records will be returned.
55 * API result Array of matching contribution_recurs
57 function civicrm_api3_contribution_recur_get($params) {
58 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
62 * Cancel a recurring contribution of existing ContributionRecur given its id.
64 * @param array $params
65 * Array containing id of the recurring contribution.
68 * returns true is successfully cancelled
70 function civicrm_api3_contribution_recur_cancel($params) {
71 return CRM_Contribute_BAO_ContributionRecur
::cancelRecurContribution($params) ?
civicrm_api3_create_success() : civicrm_api3_create_error(ts('Error while cancelling recurring contribution'));
75 * Adjust Metadata for Cancel action.
77 * The metadata is used for setting defaults, documentation & validation.
79 * @param array $params
80 * Array of parameters determined by getfields.
82 function _civicrm_api3_contribution_recur_cancel_spec(&$params) {
84 'title' => ts('Contribution Recur ID'),
85 'api.required' => TRUE,
86 'type' => CRM_Utils_Type
::T_INT
,
91 * Delete an existing ContributionRecur.
93 * This method is used to delete an existing ContributionRecur given its id.
95 * @param array $params
101 function civicrm_api3_contribution_recur_delete($params) {
102 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);