Ninja Forms Developer Docs

Class

NF_Recurly_Actions_Subscribe

__construct public: Constructor
save public
process public
enqueue_scripts public
output_form public
get_active_recurly_actions private
get_currency private

Class

NF_Recurly_Admin_Metaboxes_Submission

__construct public
render_metabox public

Class

NF_Recurly_Admin_Settings

__construct public
plugin_settings public
plugin_settings_groups public
validate_recurly_public_key_required public
validate_recurly_private_key_required public
validate_recurly_subdomain public
sanitize_recurly_subdomain public

Class

NF_Recurly_Fields_CreditCard

Class NF_Field_RecurlyExample

__construct public

Class

Recurly_Account

Class Recurly_Account

Property

Recurly_Stub $adjustments The URL of adjustments for the specified account.

Property

Recurly_Stub $account_balance The URL of the account balance for the specified account.

Property

Recurly_Stub $billing_info The URL of billing info for the specified account.

Property

Recurly_Stub $invoices The URL of invoices for the specified account.

Property

Recurly_Stub $redemption The URL of the coupon redemption for the specified account.

Property

Recurly_Stub $subscriptions The URL of subscriptions for the specified account.

Property

Recurly_Stub $transactions The URL of transactions for the specified account.

Property

string $account_code The unique identifier of the account.

Property

string $state The state of accounts to return: active or closed.

Property

string $username The username of the account.

Property

string $email The email address of the account.

Property

string[] $cc_emails Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the email field also receives.

Property

string $first_name The first name of the account.

Property

string $last_name The last name of the account.

Property

string $company_name The company name of the account.

Property

string $vat_number The VAT number of the account (to avoid having the VAT applied).

Property

boolean $tax_exempt The tax status of the account. true exempts tax on the account, false applies tax on the account.

Property

Recurly_Address $address The nested address information of the account: address1, address2, city, state, zip, country, phone.

Property

string $accept_language The ISO 639-1 language code from the user's browser, indicating their preferred language and locale.

Property

string $hosted_login_token The unique token for automatically logging the account in to the hosted management pages. You may automatically log the user into their hosted management pages by directing the user to: https://:subdomain.recurly.com/account/:hosted_login_token.

Property

DateTime $created_at The date and time the account was created in Recurly.

Property

DateTime $updated_at The date and time the account or its billing info was last updated.

Property

DateTime $closed_at For closed accounts, the date and time it was closed.

__construct
get public
create public
update public
close public
closeAccount public
reopen public
reopenAccount public
createShippingAddress public
uri protected
uriForAccount protected
getNodeName protected
getWriteableAttributes protected
getRequiredAttributes protected

Class

Recurly_AccountAcquisition

get public
deleteForAccount public
uriForAccountAcquisition protected
create public
update public
delete public
uri protected
getNodeName protected
getWriteableAttributes protected

Class

Recurly_AccountBalance

get public
__construct
getNodeName protected
getWriteableAttributes protected

Class

Recurly_AccountList

getActive public
getClosed public
getPastDue public
get public
getNodeName protected

Class

Recurly_Addon

__construct
get public
create public
update public
delete public
uri protected
uriForAddOn protected
getNodeName protected
getWriteableAttributes protected

Class

Recurly_AddonList

get public
getNodeName protected

Class

Recurly_Address

getNodeName protected
getWriteableAttributes protected

Class

Recurly_Adjustment

class Recurly_Adjustment

Property

string $type The type of adjustment to return: charge or credit.

Property

Recurly_Stub $account The URL of the account for the specified adjustment.

Property

Recurly_Stub $invoice The URL of the invoice for the specified adjustment.

Property

string $uuid The unique identifier of the adjustment.

Property

string $state The state of the adjustments to return: pending or invoiced.

Property

string $description Description of the adjustment for the adjustment. Max 255 characters.

Property

string $accounting_code Accounting code. Max of 20 characters.

Property

string $origin The origin of the adjustment to return: plan, plan_trial, setup_fee, add_on, add_on_trial, one_time, debit, credit, coupon, or carryforward.

Property

integer $unit_amount_in_cents Positive amount for a charge, negative amount for a credit. Max 10000000.

Property

integer $quantity Quantity.

Property

string $original_adjustment_uuid Only shows if adjustment is a credit created from another credit.

Property

integer $discount_in_cents The discount on the adjustment, in cents.

Property

integer $tax_in_cents The tax on the adjustment, in cents.

Property

integer $total_in_cents The total amount of the adjustment, in cents.

Property

string $currency Currency, 3-letter ISO code.

Property

boolean $taxable true if the current adjustment is taxable, false if it is not.

Property

string $tax_type The tax type of the adjustment.

Property

string $tax_region The tax region of the adjustment.

Property

string $tax_rate The tax rate of the adjustment.

Property

boolean $tax_exempt true exempts tax on the charge, false applies tax on the charge. If not defined, then defaults to the Plan and Site settings. This attribute does not work for credits (negative adjustments). Credits are always post-tax. Pre-tax discounts should use the Coupons feature.

Property

mixed[] $tax_details The nested address information of the adjustment: name, type, tax_rate, tax_in_cents.

Property

string $tax_code Optional field for EU VAT merchants and Avalara AvaTax Pro merchants. If you are using Recurly's EU VAT feature, you can use values of unknown, physical, or digital. If you have your own AvaTax account configured, you can use Avalara tax codes to assign custom tax rules.

Property

DateTime $start_date A timestamp associated with when the adjustment began.

Property

DateTime $end_date A timestamp associated with when the adjustment ended.

Property

DateTime $created_at A timestamp associated with when the adjustment was created.

get public
create public
delete public
refund public: Allows you to refund this particular item if it's a part of an invoice. It does this by calling the invoice's refund() Only 'invoiced' adjustments can be refunded.

Param
Integer the quantity you wish to refund, defaults to refunding the entire quantity
Param
Boolean indicates whether you want this adjustment refund prorated
Param
String indicates the refund order to apply, valid options: {'credit','transaction'}, defaults to 'credit'
Return
Recurly_Invoice the new refund invoice
Throws
Recurly_Error if the adjustment cannot be refunded.
toRefundAttributes public: Converts this adjustment into the attributes needed for a refund.

Param
Integer the quantity you wish to refund, defaults to refunding the entire quantity
Param
Boolean indicates whether you want this adjustment refund prorated
Return
Array an array of refund attributes to be fed into invoice->refund()
createUriForAccount protected
getNodeName protected
getWriteableAttributes protected

Class

Recurly_AdjustmentList

get public
getNodeName protected

Class

Recurly_Base

__construct public
_get public
_post protected
_put protected
_delete protected
_uriWithParams protected
__toString public: Pretty string version of the object
__valuesString protected
getHref public
setHref public
getType public: Refers to the `type` root xml attribute
addLink private
getLinks public
__parseResponseToNewObject protected
_afterParseResponse protected
__parseXmlToUpdateObject protected
__parseXmlToObject protected
parseErrorNode private
__createNodeObject private

Class

Recurly_Object

Class

Recurly_BillingInfo

class Recurly_BillingInfo

Property

string $account_code Account's unique code.

Property

string $token_id A token generated by Recurly.js

Property

string $currency Currency in which invoices will be posted. Only applicable if this account is enrolled in a plan has a different currency than your site's default.

Property

string $first_name First name

Property

string $last_name Last name

Property

string $number Credit card number, spaces and dashes are accepted

Property

int $month Expiration month

Property

int $year Expiration year

Property

string $address1 Address line 1, recommended for address validation

Property

string $address2 Address line 2.

Property

string $city City

Property

string $state State

Property

string $country Country, 2-letter ISO code STRONGLY RECOMMENDED

Property

string $zip Zip or postal code, recommended for address validation

Property

string $phone Phone number

Property

string $company Customer's company

Property

string $vat_number Customer's VAT Number

Property

string $currency Currency in which invoices will be posted. Only applicable if this account is enrolled in a plan has a different currency than your site's default.

Property

string $verification_value Security code or CVV, 3-4 digits STRONGLY RECOMMENDED

Property

string $ip_address Customer's IP address when updating their Billing Information STRONGLY RECOMMENDED

get public
create public
update public
delete public
deleteForAccount public
uri protected
uriForBillingInfo protected
getNodeName protected
getWriteableAttributes protected

Class

Recurly_Client

Recurly_Client provides methods for interacting with the {

Link

https://dev.recurly.com/docs/getting-started Recurly} API.
@category Recurly

Package

Recurly_Client_PHP

Copyright

Link

http://recurly.com Recurly, Inc.}

__construct /** * Create a new Recurly Client * @param string API key. Do not specify to use the default API key (which must be set at the static variable) * @param string "Accept-language" header variable from the current user's browser. Localizes validation messages. */
request public
baseUri public
apiKey public: Current API key
Return
string API key
_sendRequest private: Sends an HTTP request to the Recurly API

Param
string $method Specifies the HTTP method to be used for this request
Param
string $uri Target URI for this request (relative to the API root)
Param
mixed $data x-www-form-urlencoded data (or array) to be sent in a POST request body

Return
$code, $response
__userAgent private
_getHeaders private
_raiseCurlError private
getFile public: Saves the contents of a URI into a file handle.

Param
string $uri Target URI for the request (complete URL)
Param
resource $file_pointer Resourced returned from fopen() with write mode.
getPdf public: Requests a PDF document from the given URI

Param
string $uri Target URI for this request (relative to the API root)
Param
string $locale Locale for the PDF invoice (e.g. "en-GB", "en-US", "fr")
Return
string $response PDF document

Class

Recurly_Coupon

__construct
get public
create public
redeemCoupon public
update public
restore public
delete public
deleteCoupon public
createUpdateXML public
generate public
uri protected
uriForCoupon protected
getNodeName protected
getWriteableAttributes protected
getUpdatableAttributes protected

Class

Recurly_CouponList

get public
getNodeName protected

Class

Recurly_Currency

An amount with a currency.

__construct
amount public: Amount in dollars, or whatever your currency may be.
Return
float Amount in dollars
__toString public

Class

Recurly_CurrencyList

__construct
addCurrency public
getCurrency public
offsetSet public
offsetExists public
offsetUnset public
offsetGet public
__set public
__get public
count public
getIterator public
populateXmlDoc public
__toString public

Class

Recurly_Delivery

getNodeName protected
getWriteableAttributes protected

Class

Recurly_ErrorList

Array of errors

__construct
offsetSet public
offsetExists public
offsetUnset public
offsetGet public
count public
getIterator public
__toString public

Class

Recurly_Error

Exception class used by the Recurly PHP Client.
@category Recurly

Package

Recurly_Client_PHP

Copyright

Link

http://recurly.com Recurly, Inc.}

__construct public
getRecurlyCode public

Class

Recurly_NotFoundError

Class

Recurly_UnauthorizedError

Class

Recurly_ConfigurationError

Class

Recurly_ConnectionError

Class

Recurly_RequestError

Class

Recurly_ApiRateLimitError

Class

Recurly_ForgedQueryStringError

Class

Recurly_ValidationError

__construct

Class

Recurly_ServerError

Class

Recurly_FieldError

__toString public
__readableField private

Class

Recurly_ExportDate

getNodeName protected
getWriteableAttributes protected

Class

Recurly_ExportDateList

get public
getNodeName protected

Class

Recurly_ExportFile

get public
getNodeName protected
getWriteableAttributes protected
download /** * Download the file. * * @param resource $file_pointer Resourced returned from fopen() with write mode. */

Class

Recurly_ExportFileList

get public
getNodeName protected

Class

Recurly_FraudInfo

Represents the object in a transaction

__toString public

Class

Recurly_GiftCard

get public
redeem public: Redeem a gift card given an account code
create public
preview public: Preview the creation and check for errors.
Note: once preview() has been called you will not be able to call create() without reassiging all the attributes.
uri protected
uriForGiftCard protected
getNodeName protected
getWriteableAttributes protected

Class

Recurly_GiftCardList

get public
getNodeName protected

Class

Recurly_Invoice

get public
getPdf public: Retrieve the PDF version of this invoice
getInvoicePdf public
invoicePendingCharges public
previewPendingCharges public
markSuccessful public
markFailed public
invoiceNumberWithPrefix public
refundAmount public: Refunds an open amount from the invoice and returns a new refund invoice
Param
Integer amount in cents to refund from this invoice
Param
String indicates the refund order to apply, valid options: {'credit','transaction'}, defaults to 'credit'
Return
Recurly_Invoice a new refund invoice
refund public: Refunds given line items from an invoice and returns new refund invoice
Param
Array refund attributes or Array of refund attributes to refund (see 'REFUND ATTRIBUTES' in docs or Recurly_Adjustment#toRefundAttributes)
Param
String indicates the refund order to apply, valid options: {'credit','transaction'}, defaults to 'credit'
Return
Recurly_Invoice a new refund invoice
createRefundInvoice protected
getNodeName protected
getWriteableAttributes protected
uri protected
uriForInvoice protected

Class

Recurly_InvoiceList

getOpen public
getCollected public
getFailed public
getPastDue public
get public
getForAccount public
getNodeName protected

Class

Recurly_Link

__construct
__toString public

Class

Recurly_MeasuredUnit

create public
get public
uri protected
uriForMeasuredUnit protected
getNodeName protected
getWriteableAttributes protected

Class

Recurly_MeasuredUnitList

get public
getNodeName protected

Class

Recurly_Note

getNodeName protected
getWriteableAttributes protected

Class

Recurly_NoteList

get public
getNodeName protected

Class

Recurly_Pager

count public: Number of records in this list.
Return
integer number of records in list
rewind public: Rewind to the beginning
current public: The current object
Return
Recurly_Resource the current object
key public: Return
integer current position within the current page
next public: Increments the position to the next element
valid public: Return
boolean True if the current position is valid.
_loadFrom protected: Load another page of results into this pager.
_afterParseResponse protected
_setState protected
_loadLinks private: The 'Links' header contains links to the next, previous, and starting pages. This parses the links header into an array of links if the header is present.
_loadRecordCount private: Find the total number of results in the collection from the 'X-Records' header.
updateErrorAttributes protected
__toString public

Class

Recurly_Plan

class Recurly_Plan

Property

string $plan_code Unique code to identify the plan. This code may only contain the following characters: [a-z 0-9 @ - _ .]. Max of 50 characters.

Property

string $name Plan name. Max of 255 characters.

Property

Recurly_CurrencyList $unit_amount_in_cents Array of currency objects, see example below. Max 10000000.

Property

string $description Optional plan description, not displayed.

Property

string $plan_interval_unit days, or months, defaults to months.

Property

integer $plan_interval_length Plan interval length, defaults to 1

Property

string $trial_interval_unit days or months, defaults to months.

Property

integer $trial_interval_length Defaults to 0, for no trial

Property

string $success_url URL to redirect to after signup on the hosted payment pages.

Property

string $accounting_code Accounting code for related invoice line items, code may only contain the following characters: [a-z 0-9 @ - _ .]. Max of 20 characters.

Property

string $revenue_schedule_type Optional field for setting a revenue schedule type. This will determine how revenue for the associated Plan should be recognized. When creating a Plan, available schedule types are never, evenly, at_range_start, or at_range_end.

Property

string $setup_fee_accounting_code Accounting code for a Setup Fee, code may only contain the following characters: [a-z 0-9 @ - _ .]. Max of 20 characters.

Property

string $setup_fee_revenue_schedule_type Optional field for setting a revenue schedule type. This will determine how revenue for the associated Plan Setup Fee should be recognized. When creating a Plan Setup Fee, available schedule types are never, evenly, at_range_start, or at_range_end.

Property

Recurly_CurrencyList $setup_fee_in_cents Array of currency objects, see examples. Max 10000000.

Property

string $total_billing_cycles Number of billing cycles before the plan stops renewing, defaults to null for continuous auto renewal.

Property

string $unit_name Deprecated Unit description for the quantity, e.g. users.

Property

boolean $display_quantity Display the quantity field on the hosted payment page if true, defaults to false.

Property

string $cancel_url Deprecated URL to redirect to on canceled signup on the hosted payment pages.

Property

boolean $tax_exempt true exempts tax on the plan, false applies tax on the plan. If not defined, then defaults to the Plan and Site settings.

Property

string $tax_code Optional field for EU VAT merchants and Avalara AvaTax Pro merchants. If you are using Recurly's EU VAT feature, you can use values of unknown, physical, or digital. If you have your own AvaTax account configured, you can use Avalara tax codes to assign custom tax rules.

Property

string $plan_code The unique plan code

Property

string $add_on_code Add-on code. Max of 50 characters.

Property

string $add_on_type Whether the add-on is Fixed-Price (fixed), or Usage-Based (usage).

Property

integer $default_quantity Default quantity for the hosted pages.

Property

Recurly_CurrencyList $unit_amount_in_cents Array of unit amounts with their currency code. Max 10000000.

Property

string $name Add-on name. Max of 255 characters.

Property

boolean $display_quantity_on_hosted_page If true, display a quantity field on the hosted pages for the add-on.

Property

boolean $optional Whether the add-on is optional for the customer to include in their purchase on the hosted payment page.

Property

string $measured_unit_id The id of the measured unit on your site associated with the add-on.

Property

string $usage_type If add_on_type = usage, you must set a usage_type, which can be price or percentage. If price, the price is defined in unit_amount_in_cents. If percentage, the percentage is defined in usage_percentage.

Property

string $usage_percentage If add_on_type = usage and usage_type = percentage, you must set a usage_percentage. Must be between 0.0000 and 100.0000.

__construct
get public
create public
update public
delete public
deletePlan public
uri protected
uriForPlan protected
getNodeName protected
getWriteableAttributes protected

Class

Recurly_PlanList

get public
getNodeName protected

Class

Recurly_PushNotification

Example: $post_xml = file_get_contents ("php://input"); $notification = new Recurly_PushNotification($post_xml);

__construct
parseXml

Class

Recurly_js

__construct
get_signature public
sign public
fetch public
_hash public
utc_timestamp protected
get_nonce protected

Class

Recurly_CouponRedemption

get public
delete public
uri protected
uriForAccount protected
getNodeName protected
getWriteableAttributes protected

Class

Recurly_CouponRedemptionList

getForAccount public
getForInvoice public
getForSubscription public
getNodeName protected

Class

Recurly_Resource

getNodeName protected
getWriteableAttributes protected
getRequiredAttributes protected
__construct public
__set public
__isset public
__unset public
getValues public: Return all of the values associated with this resource.

Return
array The array of values stored with this resource.
getErrors public
setValues public: Does a mass assignment on this resource's values

Param
array The array of values to set on the resource.
_save protected
xml public
createDocument public
renderXML public
populateXmlDoc protected
getChangedAttributes protected
updateErrorAttributes protected

Class

Recurly_ClientResponse

__construct
assertSuccessResponse public
assertValidResponse public
parseErrorXml private
parseErrorNode private

Class

Recurly_ShippingAddress

update public
getNodeName protected
getWriteableAttributes protected
populateXmlDoc protected
isEmbedded private

Class

Recurly_ShippingAddressList

get public
getNodeName protected

Class

Recurly_Stub

Resource stub for Recurly API. Call get() to retrieve the stubbed resource.

__construct
get /** * Retrieve the stubbed resource. */
__toString public

Class

Recurly_Subscription

__construct public
get public
create public
preview public: Preview the creation and check for errors.
Note: once preview() has been called you will not be able to call create() or save() without reassiging all the attributes.
cancel public: Cancel the subscription; it will remain active until it renews.
reactivate public: Reactivate a canceled subscription. The subscription will return back to the active, auto renewing state.
updateImmediately public: Make an update that takes effect immediately.
updateAtRenewal public: Make an update that applies when the subscription renews.
terminateAndRefund public: Terminate the subscription immediately and issue a full refund of the last renewal
terminateAndPartialRefund public: Terminate the subscription immediately and issue a prorated/partial refund of the last renewal
terminateWithoutRefund public: Terminate the subscription immediately without a refund
terminate private
postpone public: Postpone a subscription's renewal date.

Param
String ISO8601 DateTime String, postpone the subscription to this date
Param
Boolean bulk is for making bulk updates, setting to true bypasses api check for accidental duplicate subscriptions.
updateNotes public: Updates the notes fields of the subscription without generating a SubscriptionChange.

Param
array of notes, allowed keys: (customer_notes, terms_and_conditions, vat_reverse_charge_notes)
buildUsage public
usages public
uri protected
uriForSubscription protected
getNodeName protected
getWriteableAttributes protected

Class

Recurly_SubscriptionAddOn

getNodeName protected
getWriteableAttributes protected
populateXmlDoc protected
getChangedAttributes protected
__toString public: Pretty string version of the object

Class

Recurly_SubscriptionList

getActive public
getCanceled public
getExpired public
getFuture public
getLive public
getPastDue public
getTrials public
get public
getForAccount public
getNodeName protected

Class

Recurly_Tax_Detail

getNodeName protected
getWriteableAttributes protected

Class

Recurly_Transaction

Class Recurly_Transaction

Property

string $uuid Transaction's unique identifier.

Property

Recurly_Stub $account The URL of the account associated with the transaction. Run get() to pull back a Recurly_Account

Property

Recurly_Stub $invoice The URL of the invoice associated with the transaction. Run get() to pull back a Recurly_Invoice

Property

Recurly_Stub $subscription The URL of the subscription associated with the transaction. Run get() to pull back a Recurly_Subscription

Property

string $original_transaction For refund transactions, the URL of the original transaction. Run get() to pull back a Recurly_Transaction

Property

string $action purchase, verify or refund.

Property

integer $amount_in_cents Total transaction amount in cents.

Property

integer $tax_in_cents Amount of tax or VAT within the transaction, in cents.

Property

string $currency 3-letter currency for the transaction.

Property

string $status success, declined, or void.

Property

string $payment_method credit_card, paypal, check, wire_transfer, money_order.

Property

string $reference Transaction reference from your payment gateway.

Property

string $source Source of the transaction. Possible values: transaction for one-time transactions, subscription for subscriptions, billing_info for updating billing info.

Property

boolean $recurring True if transaction is recurring.

Property

boolean $test True if test transaction.

Property

boolean $voidable True if the transaction may be voidable, accuracy depends on your gateway.

Property

string $refundable True if the transaction may be refunded.

Property

string $ip_address Customer's IP address on the transaction, if applicable.

Property

string $cvv_result CVV result, if applicable.

Property

string $avs_result AVS result, if applicable.

Property

string $avs_result_street AVS result for the street address, line 1.

Property

string $avs_result_postal AVS result for the postal code.

Property

DateTime $created_at Date the transaction took place.

Property

DateTime $updated_at Date the transaction was last modified.

Property

mixed[] $details Nested account and billing information submitted at the time of the transaction. When writing a client library, do not map these directly to Account or Billing Info objects. Retrieve data by accessing the array details[0]->fieldname i.e. details[0]->email

Property

string $error_code For declined transactions, the error code (if applicable).

Property

string $error_category For declined transactions, the error category (if applicable).

Property

string $merchant_message For declined transactions, the message displayed to the merchant (if applicable).

Property

string $customer_message For declined transactions, the message displayed to the customer (if applicable).

Property

string $gateway_error_code For declined transactions, this field lists the gateway error code sent to us from the gateway (if applicable).

get public
create public
refund public: Refund a previous, successful transaction
void public: Attempt a void, otherwise refund
uri protected
uriForTransaction protected
getNodeName protected
getWriteableAttributes protected

Class

Recurly_TransactionError

__toString public

Class

Recurly_TransactionList

getSuccessful public
getVoided public
get public
getForAccount public
getNodeName protected

Class

Recurly_UniqueCouponCodeList

get public
getNodeName protected

Class

Recurly_Usage

build public
create public
update public
get public
uri protected
uriForUsages protected
uriForUsage protected
getNodeName protected
getWriteableAttributes protected

Class

Recurly_UsageList

get public
getNodeName protected

Class

Recurly_HmacHash

hash public

Class

NF_Recurly

instance public
__construct public
setup_vars public
ninja_forms_before_container public
builder_scripts public
register_actions public: Optional. If your extension processes or alters form submission data on a per form basis...
enqueue_scripts public
autoloader public
template public
config public
setup_license public
custom_template_path public
setup_admin public: Setup Admin
Setup admin classes for Ninja Forms and WordPress.
NF_Recurly /** * The main function responsible for returning The Highlander Plugin * Instance to functions everywhere. * * Use this function like you would a global variable, except without needing * to declare the global. * * @since 3.0 * @return {class} Highlander Instance */