Recurly v3 API

Account extends RecurlyResource

Table of Contents

$array_hints  : mixed
$_address  : mixed
$_bill_to  : mixed
$_billing_info  : mixed
$_cc_emails  : mixed
$_code  : mixed
$_company  : mixed
$_created_at  : mixed
$_custom_fields  : mixed
$_deleted_at  : mixed
$_dunning_campaign_id  : mixed
$_email  : mixed
$_entity_use_code  : mixed
$_exemption_certificate  : mixed
$_external_accounts  : mixed
$_first_name  : mixed
$_has_active_subscription  : mixed
$_has_canceled_subscription  : mixed
$_has_future_subscription  : mixed
$_has_live_subscription  : mixed
$_has_past_due_invoice  : mixed
$_has_paused_subscription  : mixed
$_hosted_login_token  : mixed
$_id  : mixed
$_invoice_template_id  : mixed
$_last_name  : mixed
$_object  : mixed
$_override_business_entity_id  : mixed
$_parent_account_id  : mixed
$_preferred_locale  : mixed
$_preferred_time_zone  : mixed
$_response  : mixed
$_shipping_addresses  : mixed
$_state  : mixed
$_tax_exempt  : mixed
$_updated_at  : mixed
$_username  : mixed
$_vat_number  : mixed
__construct()  : mixed
Constructor
__debugInfo()  : array<string|int, mixed>
Override of the magic method __debugInfo that will only return the relevant attributes of the \Recurly\RecurlyResource
__set()  : void
Guard against setting invalid properties
cast()  : RecurlyResource
Recursively converts a response object into a \Recurly\RecurlyResource.
fromBinary()  : BinaryFile
Converts a binary response into a Recurly BinaryFile
fromEmpty()  : EmptyResource
Returns a \Recurly\EmptyResource for API requests that do not have a response body.
fromResponse()  : RecurlyResource
Converts a Recurly response object into a \Recurly\RecurlyResource.
getAddress()  : Address|null
Getter method for the address attribute.
getBillingInfo()  : BillingInfo|null
Getter method for the billing_info attribute.
getBillTo()  : string|null
Getter method for the bill_to attribute.
getCcEmails()  : string|null
Getter method for the cc_emails attribute.
getCode()  : string|null
Getter method for the code attribute.
getCompany()  : string|null
Getter method for the company attribute.
getCreatedAt()  : string|null
Getter method for the created_at attribute.
getCustomFields()  : array<string|int, mixed>
Getter method for the custom_fields attribute.
getDeletedAt()  : string|null
Getter method for the deleted_at attribute.
getDunningCampaignId()  : string|null
Getter method for the dunning_campaign_id attribute.
getEmail()  : string|null
Getter method for the email attribute.
getEntityUseCode()  : string|null
Getter method for the entity_use_code attribute.
getExemptionCertificate()  : string|null
Getter method for the exemption_certificate attribute.
getExternalAccounts()  : array<string|int, mixed>
Getter method for the external_accounts attribute.
getFirstName()  : string|null
Getter method for the first_name attribute.
getHasActiveSubscription()  : bool|null
Getter method for the has_active_subscription attribute.
getHasCanceledSubscription()  : bool|null
Getter method for the has_canceled_subscription attribute.
getHasFutureSubscription()  : bool|null
Getter method for the has_future_subscription attribute.
getHasLiveSubscription()  : bool|null
Getter method for the has_live_subscription attribute.
getHasPastDueInvoice()  : bool|null
Getter method for the has_past_due_invoice attribute.
getHasPausedSubscription()  : bool|null
Getter method for the has_paused_subscription attribute.
getHostedLoginToken()  : string|null
Getter method for the hosted_login_token attribute.
getId()  : string|null
Getter method for the id attribute.
getInvoiceTemplateId()  : string|null
Getter method for the invoice_template_id attribute.
getLastName()  : string|null
Getter method for the last_name attribute.
getObject()  : string|null
Getter method for the object attribute.
getOverrideBusinessEntityId()  : string|null
Getter method for the override_business_entity_id attribute.
getParentAccountId()  : string|null
Getter method for the parent_account_id attribute.
getPreferredLocale()  : string|null
Getter method for the preferred_locale attribute.
getPreferredTimeZone()  : string|null
Getter method for the preferred_time_zone attribute.
getResponse()  : Response
Getter for the Recurly HTTP Response
getShippingAddresses()  : array<string|int, mixed>
Getter method for the shipping_addresses attribute.
getState()  : string|null
Getter method for the state attribute.
getTaxExempt()  : bool|null
Getter method for the tax_exempt attribute.
getUpdatedAt()  : string|null
Getter method for the updated_at attribute.
getUsername()  : string|null
Getter method for the username attribute.
getVatNumber()  : string|null
Getter method for the vat_number attribute.
setAddress()  : void
Setter method for the address attribute.
setBillingInfo()  : void
Setter method for the billing_info attribute.
setBillTo()  : void
Setter method for the bill_to attribute.
setCcEmails()  : void
Setter method for the cc_emails attribute.
setCode()  : void
Setter method for the code attribute.
setCompany()  : void
Setter method for the company attribute.
setCreatedAt()  : void
Setter method for the created_at attribute.
setCustomFields()  : void
Setter method for the custom_fields attribute.
setDeletedAt()  : void
Setter method for the deleted_at attribute.
setDunningCampaignId()  : void
Setter method for the dunning_campaign_id attribute.
setEmail()  : void
Setter method for the email attribute.
setEntityUseCode()  : void
Setter method for the entity_use_code attribute.
setExemptionCertificate()  : void
Setter method for the exemption_certificate attribute.
setExternalAccounts()  : void
Setter method for the external_accounts attribute.
setFirstName()  : void
Setter method for the first_name attribute.
setHasActiveSubscription()  : void
Setter method for the has_active_subscription attribute.
setHasCanceledSubscription()  : void
Setter method for the has_canceled_subscription attribute.
setHasFutureSubscription()  : void
Setter method for the has_future_subscription attribute.
setHasLiveSubscription()  : void
Setter method for the has_live_subscription attribute.
setHasPastDueInvoice()  : void
Setter method for the has_past_due_invoice attribute.
setHasPausedSubscription()  : void
Setter method for the has_paused_subscription attribute.
setHostedLoginToken()  : void
Setter method for the hosted_login_token attribute.
setId()  : void
Setter method for the id attribute.
setInvoiceTemplateId()  : void
Setter method for the invoice_template_id attribute.
setLastName()  : void
Setter method for the last_name attribute.
setObject()  : void
Setter method for the object attribute.
setOverrideBusinessEntityId()  : void
Setter method for the override_business_entity_id attribute.
setParentAccountId()  : void
Setter method for the parent_account_id attribute.
setPreferredLocale()  : void
Setter method for the preferred_locale attribute.
setPreferredTimeZone()  : void
Setter method for the preferred_time_zone attribute.
setShippingAddresses()  : void
Setter method for the shipping_addresses attribute.
setState()  : void
Setter method for the state attribute.
setTaxExempt()  : void
Setter method for the tax_exempt attribute.
setUpdatedAt()  : void
Setter method for the updated_at attribute.
setUsername()  : void
Setter method for the username attribute.
setVatNumber()  : void
Setter method for the vat_number attribute.
encodeApiKey()  : string
Base64 encodes the API key
getUserAgent()  : string
Generates User-Agent for API requests
hintArrayType()  : string
The hintArrayType method will provide type hinting for setter methods that have array parameters.
resourceClass()  : string
Converts a string into a representation of a Recurly Resource
setResponse()  : void
Setter for the Recurly HTTP Response
setterParamClass()  : string
Uses the Reflection API to determine what \Recurly\RecurlyResource is the expected parameter for the given method.
titleize()  : string
Capitalizes all the words in the $input.

Properties

$array_hints

protected static mixed $array_hints = ['setCustomFields' => '\Recurly\Resources\CustomField', 'setExternalAccounts' => '\Recurly\Resources\ExternalAccount', 'setShippingAddresses' => '\Recurly\Resources\ShippingAddress']

$_billing_info

private mixed $_billing_info

$_cc_emails

private mixed $_cc_emails

$_created_at

private mixed $_created_at

$_custom_fields

private mixed $_custom_fields

$_deleted_at

private mixed $_deleted_at

$_dunning_campaign_id

private mixed $_dunning_campaign_id

$_entity_use_code

private mixed $_entity_use_code

$_exemption_certificate

private mixed $_exemption_certificate

$_external_accounts

private mixed $_external_accounts

$_first_name

private mixed $_first_name

$_has_active_subscription

private mixed $_has_active_subscription

$_has_canceled_subscription

private mixed $_has_canceled_subscription

$_has_future_subscription

private mixed $_has_future_subscription

$_has_live_subscription

private mixed $_has_live_subscription

$_has_past_due_invoice

private mixed $_has_past_due_invoice

$_has_paused_subscription

private mixed $_has_paused_subscription

$_hosted_login_token

private mixed $_hosted_login_token

$_invoice_template_id

private mixed $_invoice_template_id

$_last_name

private mixed $_last_name

$_override_business_entity_id

private mixed $_override_business_entity_id

$_parent_account_id

private mixed $_parent_account_id

$_preferred_locale

private mixed $_preferred_locale

$_preferred_time_zone

private mixed $_preferred_time_zone

$_shipping_addresses

private mixed $_shipping_addresses

$_tax_exempt

private mixed $_tax_exempt

$_updated_at

private mixed $_updated_at

$_vat_number

private mixed $_vat_number

Methods

__construct()

Constructor

public final __construct() : mixed
Return values
mixed —

__debugInfo()

Override of the magic method __debugInfo that will only return the relevant attributes of the \Recurly\RecurlyResource

public __debugInfo() : array<string|int, mixed>
Tags
codeCoverageIgnore
Return values
array<string|int, mixed> —

__set()

Guard against setting invalid properties

public __set(string $key, mixed $value) : void
Parameters
$key : string

The parameter name that is being set

$value : mixed

The parameter value that is being set

Tags
codeCoverageIgnore
Return values
void —

cast()

Recursively converts a response object into a \Recurly\RecurlyResource.

public static cast(object $data) : RecurlyResource
Parameters
$data : object

PHP Object containing the decoded JSON

Return values
RecurlyResource —

An instance of a Recurly Resource

fromBinary()

Converts a binary response into a Recurly BinaryFile

public static fromBinary(string $data, Response $response) : BinaryFile
Parameters
$data : string

The binary file data

$response : Response

(optional) The Recurly HTTP Response

Return values
BinaryFile —

An instance of a Recurly BinaryFile

fromResponse()

Converts a Recurly response object into a \Recurly\RecurlyResource.

public static fromResponse(Response $response[, object $json = null ]) : RecurlyResource
Parameters
$response : Response

The Recurly HTTP Response

$json : object = null

(optional) JSON payload to use instead of the $response's. Primarily used for errors

Return values
RecurlyResource —

An instance of a Recurly Resource

getAddress()

Getter method for the address attribute.

public getAddress() : Address|null
Return values
Address|null —

getBillTo()

Getter method for the bill_to attribute.

public getBillTo() : string|null

An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.

Return values
string|null —

getCcEmails()

Getter method for the cc_emails attribute.

public getCcEmails() : string|null

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.

Return values
string|null —

getCode()

Getter method for the code attribute.

public getCode() : string|null

The unique identifier of the account. This cannot be changed once the account is created.

Return values
string|null —

getCompany()

Getter method for the company attribute.

public getCompany() : string|null
Return values
string|null —

getCreatedAt()

Getter method for the created_at attribute.

public getCreatedAt() : string|null

When the account was created.

Return values
string|null —

getCustomFields()

Getter method for the custom_fields attribute.

public getCustomFields() : array<string|int, mixed>

The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.

Return values
array<string|int, mixed> —

getDeletedAt()

Getter method for the deleted_at attribute.

public getDeletedAt() : string|null

If present, when the account was last marked inactive.

Return values
string|null —

getDunningCampaignId()

Getter method for the dunning_campaign_id attribute.

public getDunningCampaignId() : string|null

Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.

Return values
string|null —

getEmail()

Getter method for the email attribute.

public getEmail() : string|null

The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.

Return values
string|null —

getEntityUseCode()

Getter method for the entity_use_code attribute.

public getEntityUseCode() : string|null

The Avalara AvaTax value that can be passed to identify the customer type for tax purposes. The range of values can be A - R (more info at Avalara). Value is case-sensitive.

Return values
string|null —

getExemptionCertificate()

Getter method for the exemption_certificate attribute.

public getExemptionCertificate() : string|null

The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.

Return values
string|null —

getExternalAccounts()

Getter method for the external_accounts attribute.

public getExternalAccounts() : array<string|int, mixed>

The external accounts belonging to this account

Return values
array<string|int, mixed> —

getFirstName()

Getter method for the first_name attribute.

public getFirstName() : string|null
Return values
string|null —

getHasActiveSubscription()

Getter method for the has_active_subscription attribute.

public getHasActiveSubscription() : bool|null

Indicates if the account has an active subscription.

Return values
bool|null —

getHasCanceledSubscription()

Getter method for the has_canceled_subscription attribute.

public getHasCanceledSubscription() : bool|null

Indicates if the account has a canceled subscription.

Return values
bool|null —

getHasFutureSubscription()

Getter method for the has_future_subscription attribute.

public getHasFutureSubscription() : bool|null

Indicates if the account has a future subscription.

Return values
bool|null —

getHasLiveSubscription()

Getter method for the has_live_subscription attribute.

public getHasLiveSubscription() : bool|null

Indicates if the account has a subscription that is either active, canceled, future, or paused.

Return values
bool|null —

getHasPastDueInvoice()

Getter method for the has_past_due_invoice attribute.

public getHasPastDueInvoice() : bool|null

Indicates if the account has a past due invoice.

Return values
bool|null —

getHasPausedSubscription()

Getter method for the has_paused_subscription attribute.

public getHasPausedSubscription() : bool|null

Indicates if the account has a paused subscription.

Return values
bool|null —

getHostedLoginToken()

Getter method for the hosted_login_token attribute.

public getHostedLoginToken() : string|null

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}.

Return values
string|null —

getId()

Getter method for the id attribute.

public getId() : string|null
Return values
string|null —

getInvoiceTemplateId()

Getter method for the invoice_template_id attribute.

public getInvoiceTemplateId() : string|null

Unique ID to identify an invoice template. Available when the site is on a Pro or Elite plan. Used to specify if a non-default invoice template will be used to generate invoices for the account. For sites without multiple invoice templates enabled, the default template will always be used.

Return values
string|null —

getLastName()

Getter method for the last_name attribute.

public getLastName() : string|null
Return values
string|null —

getObject()

Getter method for the object attribute.

public getObject() : string|null

Object type

Return values
string|null —

getOverrideBusinessEntityId()

Getter method for the override_business_entity_id attribute.

public getOverrideBusinessEntityId() : string|null

Unique ID to identify the business entity assigned to the account. Available when the Multiple Business Entities feature is enabled.

Return values
string|null —

getParentAccountId()

Getter method for the parent_account_id attribute.

public getParentAccountId() : string|null

The UUID of the parent account associated with this account.

Return values
string|null —

getPreferredLocale()

Getter method for the preferred_locale attribute.

public getPreferredLocale() : string|null

Used to determine the language and locale of emails sent on behalf of the merchant to the customer.

Return values
string|null —

getPreferredTimeZone()

Getter method for the preferred_time_zone attribute.

public getPreferredTimeZone() : string|null

The IANA time zone name used to determine the time zone of emails sent on behalf of the merchant to the customer.

Return values
string|null —

getShippingAddresses()

Getter method for the shipping_addresses attribute.

public getShippingAddresses() : array<string|int, mixed>

The shipping addresses on the account.

Return values
array<string|int, mixed> —

getState()

Getter method for the state attribute.

public getState() : string|null

Accounts can be either active or inactive.

Return values
string|null —

getTaxExempt()

Getter method for the tax_exempt attribute.

public getTaxExempt() : bool|null

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

Return values
bool|null —

getUpdatedAt()

Getter method for the updated_at attribute.

public getUpdatedAt() : string|null

When the account was last changed.

Return values
string|null —

getUsername()

Getter method for the username attribute.

public getUsername() : string|null

A secondary value for the account.

Return values
string|null —

getVatNumber()

Getter method for the vat_number attribute.

public getVatNumber() : string|null

The VAT number of the account (to avoid having the VAT applied). This is only used for manually collected invoices.

Return values
string|null —

setAddress()

Setter method for the address attribute.

public setAddress(Address $address) : void
Parameters
$address : Address
Return values
void —

setBillingInfo()

Setter method for the billing_info attribute.

public setBillingInfo(BillingInfo $billing_info) : void
Parameters
$billing_info : BillingInfo
Return values
void —

setBillTo()

Setter method for the bill_to attribute.

public setBillTo(string $bill_to) : void
Parameters
$bill_to : string
Return values
void —

setCcEmails()

Setter method for the cc_emails attribute.

public setCcEmails(string $cc_emails) : void
Parameters
$cc_emails : string
Return values
void —

setCode()

Setter method for the code attribute.

public setCode(string $code) : void
Parameters
$code : string
Return values
void —

setCompany()

Setter method for the company attribute.

public setCompany(string $company) : void
Parameters
$company : string
Return values
void —

setCreatedAt()

Setter method for the created_at attribute.

public setCreatedAt(string $created_at) : void
Parameters
$created_at : string
Return values
void —

setCustomFields()

Setter method for the custom_fields attribute.

public setCustomFields(array<string|int, mixed> $custom_fields) : void
Parameters
$custom_fields : array<string|int, mixed>
Return values
void —

setDeletedAt()

Setter method for the deleted_at attribute.

public setDeletedAt(string $deleted_at) : void
Parameters
$deleted_at : string
Return values
void —

setDunningCampaignId()

Setter method for the dunning_campaign_id attribute.

public setDunningCampaignId(string $dunning_campaign_id) : void
Parameters
$dunning_campaign_id : string
Return values
void —

setEmail()

Setter method for the email attribute.

public setEmail(string $email) : void
Parameters
$email : string
Return values
void —

setEntityUseCode()

Setter method for the entity_use_code attribute.

public setEntityUseCode(string $entity_use_code) : void
Parameters
$entity_use_code : string
Return values
void —

setExemptionCertificate()

Setter method for the exemption_certificate attribute.

public setExemptionCertificate(string $exemption_certificate) : void
Parameters
$exemption_certificate : string
Return values
void —

setExternalAccounts()

Setter method for the external_accounts attribute.

public setExternalAccounts(array<string|int, mixed> $external_accounts) : void
Parameters
$external_accounts : array<string|int, mixed>
Return values
void —

setFirstName()

Setter method for the first_name attribute.

public setFirstName(string $first_name) : void
Parameters
$first_name : string
Return values
void —

setHasActiveSubscription()

Setter method for the has_active_subscription attribute.

public setHasActiveSubscription(bool $has_active_subscription) : void
Parameters
$has_active_subscription : bool
Return values
void —

setHasCanceledSubscription()

Setter method for the has_canceled_subscription attribute.

public setHasCanceledSubscription(bool $has_canceled_subscription) : void
Parameters
$has_canceled_subscription : bool
Return values
void —

setHasFutureSubscription()

Setter method for the has_future_subscription attribute.

public setHasFutureSubscription(bool $has_future_subscription) : void
Parameters
$has_future_subscription : bool
Return values
void —

setHasLiveSubscription()

Setter method for the has_live_subscription attribute.

public setHasLiveSubscription(bool $has_live_subscription) : void
Parameters
$has_live_subscription : bool
Return values
void —

setHasPastDueInvoice()

Setter method for the has_past_due_invoice attribute.

public setHasPastDueInvoice(bool $has_past_due_invoice) : void
Parameters
$has_past_due_invoice : bool
Return values
void —

setHasPausedSubscription()

Setter method for the has_paused_subscription attribute.

public setHasPausedSubscription(bool $has_paused_subscription) : void
Parameters
$has_paused_subscription : bool
Return values
void —

setHostedLoginToken()

Setter method for the hosted_login_token attribute.

public setHostedLoginToken(string $hosted_login_token) : void
Parameters
$hosted_login_token : string
Return values
void —

setId()

Setter method for the id attribute.

public setId(string $id) : void
Parameters
$id : string
Return values
void —

setInvoiceTemplateId()

Setter method for the invoice_template_id attribute.

public setInvoiceTemplateId(string $invoice_template_id) : void
Parameters
$invoice_template_id : string
Return values
void —

setLastName()

Setter method for the last_name attribute.

public setLastName(string $last_name) : void
Parameters
$last_name : string
Return values
void —

setObject()

Setter method for the object attribute.

public setObject(string $object) : void
Parameters
$object : string
Return values
void —

setOverrideBusinessEntityId()

Setter method for the override_business_entity_id attribute.

public setOverrideBusinessEntityId(string $override_business_entity_id) : void
Parameters
$override_business_entity_id : string
Return values
void —

setParentAccountId()

Setter method for the parent_account_id attribute.

public setParentAccountId(string $parent_account_id) : void
Parameters
$parent_account_id : string
Return values
void —

setPreferredLocale()

Setter method for the preferred_locale attribute.

public setPreferredLocale(string $preferred_locale) : void
Parameters
$preferred_locale : string
Return values
void —

setPreferredTimeZone()

Setter method for the preferred_time_zone attribute.

public setPreferredTimeZone(string $preferred_time_zone) : void
Parameters
$preferred_time_zone : string
Return values
void —

setShippingAddresses()

Setter method for the shipping_addresses attribute.

public setShippingAddresses(array<string|int, mixed> $shipping_addresses) : void
Parameters
$shipping_addresses : array<string|int, mixed>
Return values
void —

setState()

Setter method for the state attribute.

public setState(string $state) : void
Parameters
$state : string
Return values
void —

setTaxExempt()

Setter method for the tax_exempt attribute.

public setTaxExempt(bool $tax_exempt) : void
Parameters
$tax_exempt : bool
Return values
void —

setUpdatedAt()

Setter method for the updated_at attribute.

public setUpdatedAt(string $updated_at) : void
Parameters
$updated_at : string
Return values
void —

setUsername()

Setter method for the username attribute.

public setUsername(string $username) : void
Parameters
$username : string
Return values
void —

setVatNumber()

Setter method for the vat_number attribute.

public setVatNumber(string $vat_number) : void
Parameters
$vat_number : string
Return values
void —

encodeApiKey()

Base64 encodes the API key

protected static encodeApiKey(string $key) : string
Parameters
$key : string

The API key to encode

Return values
string —

base64 encoded API key

getUserAgent()

Generates User-Agent for API requests

protected static getUserAgent() : string
Return values
string —

Recurly client User-Agent string

hintArrayType()

The hintArrayType method will provide type hinting for setter methods that have array parameters.

protected static hintArrayType(string $key) : string
Parameters
$key : string

The property to get teh type hint for.

Return values
string —

The class name of the expected array type.

resourceClass()

Converts a string into a representation of a Recurly Resource

protected static resourceClass(string $type) : string
Parameters
$type : string

A string to convert to a Recurly Resource

Return values
string —

The string representation of a Recurly Resource

setResponse()

Setter for the Recurly HTTP Response

protected setResponse(Response $response) : void
Parameters
$response : Response

The Recurly HTTP Response

Return values
void —

setterParamClass()

Uses the Reflection API to determine what \Recurly\RecurlyResource is the expected parameter for the given method.

protected static setterParamClass(string $method) : string
Parameters
$method : string

The name of the setter method to find the type hint for

Return values
string —

The \Recurly\RecurlyResource that the setter method expects

titleize()

Capitalizes all the words in the $input.

protected static titleize(string $input[, string $prefix = '' ]) : string
Parameters
$input : string

The string to titleize

$prefix : string = ''

(optional) Prefix to add to the beginning of the titleized string. The prefix will not be titleized.

Return values
string —

The titleized $input wtih the prepended $prefix

Search results