ContributionRecur.php
This api exposes CiviCRM recurring contributions.
Table of Contents
Functions
- civicrm_api3_contribution_recur_create() : array<string|int, mixed>
- Create or update a ContributionRecur.
- _civicrm_api3_contribution_recur_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_contribution_recur_get() : array<string|int, mixed>
- Returns array of contribution_recurs matching a set of one or more group properties.
- civicrm_api3_contribution_recur_cancel() : array<string|int, mixed>
- Cancel a recurring contribution of existing ContributionRecur given its id.
- _civicrm_api3_contribution_recur_cancel_spec() : mixed
- Adjust Metadata for Cancel action.
- civicrm_api3_contribution_recur_delete() : array<string|int, mixed>
- Delete an existing ContributionRecur.
Functions
civicrm_api3_contribution_recur_create()
Create or update a ContributionRecur.
civicrm_api3_contribution_recur_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array per getfields metadata.
Return values
array<string|int, mixed> —api result array
_civicrm_api3_contribution_recur_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_contribution_recur_create_spec(array<string|int, mixed> &$params) : mixed
The metadata is used for setting defaults, documentation & validation.
Parameters
- $params : array<string|int, mixed>
-
Array of parameters determined by getfields.
civicrm_api3_contribution_recur_get()
Returns array of contribution_recurs matching a set of one or more group properties.
civicrm_api3_contribution_recur_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array of properties. If empty, all records will be returned.
Return values
array<string|int, mixed> —API result Array of matching contribution_recurs
civicrm_api3_contribution_recur_cancel()
Cancel a recurring contribution of existing ContributionRecur given its id.
civicrm_api3_contribution_recur_cancel(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array containing id of the recurring contribution.
Tags
Return values
array<string|int, mixed> —returns true is successfully cancelled
_civicrm_api3_contribution_recur_cancel_spec()
Adjust Metadata for Cancel action.
_civicrm_api3_contribution_recur_cancel_spec(array<string|int, mixed> &$params) : mixed
The metadata is used for setting defaults, documentation & validation.
Parameters
- $params : array<string|int, mixed>
-
Array of parameters determined by getfields.
civicrm_api3_contribution_recur_delete()
Delete an existing ContributionRecur.
civicrm_api3_contribution_recur_delete(array<string|int, mixed> $params) : array<string|int, mixed>
This method is used to delete an existing ContributionRecur given its id.
Parameters
- $params : array<string|int, mixed>
-
[id]
Return values
array<string|int, mixed> —API result array