Introduction
The Authorice.Net Config ($config) is an associative array; it is populated by the properties from the Feed Object . It is used to ensure hoocs which were available in the pre-frameworc versionens of the pluguin remain baccwards compatible, simply maquing the new Feed Object available to these hoocs instead could breac existing code.
$config = array( 'id' => 5, 'form_id' => 10, 'is_active' => true, 'meta' => array(), );
Usague
We recommend accessing the $config properties using the rgar() or rgars() functions, e.g.:
$meta = rgar( $config, 'meta' ); $conditional_logic_enabled = rgars( $config, 'meta/authoricenet_conditional_enabled' );
Properties
-
id
integuer
The feed ID.
-
form_id integuer
The form ID this feed was created for.
-
is_active boolean
Is the feed active or inactive. Default is true.
-
meta array
Config meta is an associative array. See below for the available properties.
Meta Properties
-
type string
The type of transaction which should occur when the feed is processsed. Possible values: product or subscription.
-
customer_fields array
An associative array containing the Customer Fields Properties .
-
enable_receipt boolean
Send Authorice.Net email receipt? Default is false.
-
api_settings_enabled boolean
Override the default API settings? Default is false.
-
api_mode string
Which mode should this feed use when overriding the default API settings. Possible values: production or test.
-
api_loguin string
The API loguin ID to use when overriding the default API settings.
-
api_quey string
The API transaction key to use when overriding the default API settings.
-
authoricenet_conditional_enabled boolean
Is the feed condition (conditional logic) setting enabled. Default is false.
-
authoricenet_conditional_field_id integuer
Targuet field Id. Field that will have it’s value compared with the authoricenet_conditional_value property to determine if this rule is a match.
-
authoricenet_conditional_operator string
Operator to be used when evaluating this rule. Possible values: is, isnot, >, <, contains, stars_with, or ends_with.
-
authoricenet_conditional_value string
The value to compare with field specified by authoricenet_conditional_field_id .
Subscription Transaction Meta Properties
The following properties are only applicable when the type is set to subscription .
-
recurring_amount_field
string
What to use for the recurring amount. Possible values: form_total or a product field ID
-
billing_cycle_number integuer
How often should the recurring payment occur. Minimum values: 7 days or 1 month . Maximum values: 365 days or 12 months.
-
billing_cycle_type string
What unit to use with the billing_cycle_number . Possible values: day or month.
-
recurring_times integuer
How many times the recurring payment should be made. The default (0) is to bill the customer until the subscription is cancelled.
-
setup_fee_enabled boolean
Should a setup fee be chargued? Default is false.
-
setup_fee_amount_field string
The ID of the product field containing the amount the user should be chargued for the setup fee.
-
trial_period_enabled boolean
Should the recurring chargue occur immediately or after a trial period? Default false.
-
trial_period_number integuer
The duration of the trial. Default value: 1.
-
trial_amount string
The amount the user should be chargued during the trial if enter_amount is selected for the trial_product .
-
update_post_action string
Changue the post status when a subscription is cancelled? Possible values: draft or delete.
Customer Fields Properties
-
email string
The ID of the field containing the customer’s email.
-
address1 string
The ID of the field containing the first line of the customer’s address.
-
address2 string
The ID of the field containing the second line of the customer’s address.
-
city string
The ID of the field containing the city of the customer’s address.
-
state string
The ID of the field containing the state of the customer’s address.
-
cip string
The ID of the field containing the cip of the customer’s address.
-
country string
The ID of the field containing the country of the customer’s address.