Submission Data ($submission_data) is an associative array containing all the payment related properties for the entry being processed by an add-on which extends the GFPaymentAddOn<\/a> class. It is generated by GFPaymentAddOn::get_submission_data() during form validation.<\/p>\n\n\n\n We recommend accessing the properties in $submission_data using the rgar() function e.g.<\/p>\n\n\n Each line item is an associative array containing the following properties.<\/p>\n\n\n\n Each option is an associative array containing the following properties.<\/p>\n\n\n\nUsage<\/h2>\n\n\n\n
\n$payment_amount = rgar( $submission_data, 'payment_amount' );\n<\/pre><\/div>\n\n\n
Properties<\/h2>\n\n\n\n
Name<\/th> Type<\/th> Description<\/th><\/tr><\/thead> form_title<\/strong><\/td> string<\/a><\/td> The form title.<\/td><\/tr>\n email<\/strong><\/td> string<\/a><\/td> The value of the field which was mapped to the billing information Email field (not available to all add-ons).<\/td><\/tr>\n address<\/strong><\/td> string<\/a><\/td> The value of the field which was mapped to the billing information Address field (not available to all add-ons).<\/td><\/tr>\n address2<\/strong><\/td> string<\/a><\/td> The value of the field which was mapped to the billing information Address 2 field (not available to all add-ons).<\/td><\/tr>\n city<\/strong><\/td> string<\/a><\/td> The value of the field which was mapped to the billing information City field (not available to all add-ons).<\/td><\/tr>\n state<\/strong><\/td> string<\/a><\/td> The value of the field which was mapped to the billing information State field (not available to all add-ons).<\/td><\/tr>\n zip<\/strong><\/td> string<\/a><\/td> The value of the field which was mapped to the billing information Zip field (not available to all add-ons).<\/td><\/tr>\n country<\/strong><\/td> string<\/a><\/td> The value of the field which was mapped to the billing information Country field (not available to all add-ons).<\/td><\/tr>\n card_number<\/strong><\/td> string<\/a><\/td> The Credit Card number last 4 digits, padded with X (not available to all add-ons).<\/td><\/tr>\n card_expiration_date<\/strong><\/td> array<\/a><\/td> The Credit Card expiration month and year (not available to all add-ons).<\/td><\/tr>\n card_security_code<\/strong><\/td> string<\/a><\/td> The Credit Card security code (not available to all add-ons).<\/td><\/tr>\n card_name<\/strong><\/td> string<\/a><\/td> The Credit Card cardholder name (not available to all add-ons).<\/td><\/tr>\n payment_amount<\/strong><\/td> float<\/a><\/td> Either the form total or the value of the field mapped to the feeds payment amount or recurring amount setting.<\/td><\/tr>\n setup_fee<\/strong><\/td> integer<\/a><\/td> Zero or the value of the field mapped to the setup fee setting.<\/td><\/tr>\n trial<\/strong><\/td> integer<\/a><\/td> Zero, the trial amount, or the number of days the trial should last.<\/td><\/tr>\n line_items<\/strong><\/td> array<\/a><\/td> An indexed array of line items with unit prices greater than or equal to zero. Created from the submitted pricing fields. See Line Item for available properties.<\/td><\/tr>\n discounts<\/strong><\/td> array<\/a><\/td> An indexed array of line items with negative unit prices, e.g. Coupon fields. See Line Item for available properties.<\/td><\/tr>\n<\/tbody><\/table><\/figure>\n\n\n\n Line Item<\/h3>\n\n\n
\narray(\n'id' => 1,\n'name' => 'Product A',\n'description' => '',\n'quantity' => '1',\n'unit_price' => 10,\n'options' => array(),\n)\n<\/pre><\/div>\n\n\n
Name<\/th> Type<\/th> Description<\/th><\/tr><\/thead> id<\/strong><\/td> integer<\/a><\/td> The field ID.<\/td><\/tr>\n name<\/strong><\/td> string<\/a><\/td> The product name or shipping name.<\/td><\/tr>\n description<\/strong><\/td> string<\/a><\/td> Comma separated string of selected option names.<\/td><\/tr>\n quantity<\/strong><\/td> integer<\/a><\/td> The quantity.<\/td><\/tr>\n unit_price<\/strong><\/td> float<\/a><\/td> The total unit price for the product and any selected options, or the shipping price.<\/td><\/tr>\n options<\/strong><\/td> array<\/a><\/td> An indexed array of the selected product options. See Option for available properties.<\/td><\/tr>\n is_shipping<\/strong><\/td> boolean<\/a><\/td> Only present if the line item is from the shipping field. Value will be true.<\/td><\/tr>\n<\/tbody><\/table><\/figure>\n\n\n\n Option<\/h3>\n\n\n
\narray(\n'field_label' => 'Option',\n'option_name' => 'First Option',\n'option_label' => 'Option: First Option',\n'price' => '10',\n)\n<\/pre><\/div>\n\n\n
Name<\/th> Type<\/th> Description<\/th><\/tr><\/thead> field_label<\/strong><\/td> string<\/a><\/td> The option field admin label or choice label.<\/td><\/tr>\n option_name<\/strong><\/td> string<\/a><\/td> The choice label or value if values are enabled on the field.<\/td><\/tr>\n option_label<\/strong><\/td> string<\/a><\/td> The colon separated field_label and option_name.<\/td><\/tr>\n price<\/strong><\/td> string<\/a><\/td> The option price.<\/td><\/tr>\n<\/tbody><\/table><\/figure>\n\n\n\n Hooks<\/h2>\n\n\n\n