BillingInfo extends RecurlyResource
Table of Contents
- $array_hints : mixed
- $_account_id : mixed
- $_address : mixed
- $_backup_payment_method : mixed
- $_company : mixed
- $_created_at : mixed
- $_first_name : mixed
- $_fraud : mixed
- $_id : mixed
- $_last_name : mixed
- $_object : mixed
- $_payment_method : mixed
- $_primary_payment_method : mixed
- $_response : mixed
- $_updated_at : mixed
- $_updated_by : mixed
- $_valid : 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.
- getAccountId() : string|null
- Getter method for the account_id attribute.
- getAddress() : Address|null
- Getter method for the address attribute.
- getBackupPaymentMethod() : bool|null
- Getter method for the backup_payment_method attribute.
- getCompany() : string|null
- Getter method for the company attribute.
- getCreatedAt() : string|null
- Getter method for the created_at attribute.
- getFirstName() : string|null
- Getter method for the first_name attribute.
- getFraud() : FraudInfo|null
- Getter method for the fraud attribute.
- getId() : string|null
- Getter method for the id attribute.
- getLastName() : string|null
- Getter method for the last_name attribute.
- getObject() : string|null
- Getter method for the object attribute.
- getPaymentMethod() : PaymentMethod|null
- Getter method for the payment_method attribute.
- getPrimaryPaymentMethod() : bool|null
- Getter method for the primary_payment_method attribute.
- getResponse() : Response
- Getter for the Recurly HTTP Response
- getUpdatedAt() : string|null
- Getter method for the updated_at attribute.
- getUpdatedBy() : BillingInfoUpdatedBy|null
- Getter method for the updated_by attribute.
- getValid() : bool|null
- Getter method for the valid attribute.
- getVatNumber() : string|null
- Getter method for the vat_number attribute.
- setAccountId() : void
- Setter method for the account_id attribute.
- setAddress() : void
- Setter method for the address attribute.
- setBackupPaymentMethod() : void
- Setter method for the backup_payment_method attribute.
- setCompany() : void
- Setter method for the company attribute.
- setCreatedAt() : void
- Setter method for the created_at attribute.
- setFirstName() : void
- Setter method for the first_name attribute.
- setFraud() : void
- Setter method for the fraud attribute.
- setId() : void
- Setter method for the id attribute.
- setLastName() : void
- Setter method for the last_name attribute.
- setObject() : void
- Setter method for the object attribute.
- setPaymentMethod() : void
- Setter method for the payment_method attribute.
- setPrimaryPaymentMethod() : void
- Setter method for the primary_payment_method attribute.
- setUpdatedAt() : void
- Setter method for the updated_at attribute.
- setUpdatedBy() : void
- Setter method for the updated_by attribute.
- setValid() : void
- Setter method for the valid 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
= []
$_account_id
private
mixed
$_account_id
$_address
private
mixed
$_address
$_backup_payment_method
private
mixed
$_backup_payment_method
$_company
private
mixed
$_company
$_created_at
private
mixed
$_created_at
$_first_name
private
mixed
$_first_name
$_fraud
private
mixed
$_fraud
$_id
private
mixed
$_id
$_last_name
private
mixed
$_last_name
$_object
private
mixed
$_object
$_payment_method
private
mixed
$_payment_method
$_primary_payment_method
private
mixed
$_primary_payment_method
$_response
private
mixed
$_response
$_updated_at
private
mixed
$_updated_at
$_updated_by
private
mixed
$_updated_by
$_valid
private
mixed
$_valid
$_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
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
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
fromEmpty()
Returns a \Recurly\EmptyResource for API requests that do not have a response body.
public
static fromEmpty(Response $response) : EmptyResource
Parameters
- $response : Response
-
(optional) The Recurly HTTP Response
Return values
EmptyResource —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
getAccountId()
Getter method for the account_id attribute.
public
getAccountId() : string|null
Return values
string|null —getAddress()
Getter method for the address attribute.
public
getAddress() : Address|null
Return values
Address|null —getBackupPaymentMethod()
Getter method for the backup_payment_method attribute.
public
getBackupPaymentMethod() : bool|null
The backup_payment_method field is used to indicate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined.
Return values
bool|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 billing information was created.
Return values
string|null —getFirstName()
Getter method for the first_name attribute.
public
getFirstName() : string|null
Return values
string|null —getFraud()
Getter method for the fraud attribute.
public
getFraud() : FraudInfo|null
Most recent fraud result.
Return values
FraudInfo|null —getId()
Getter method for the id attribute.
public
getId() : string|null
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 —getPaymentMethod()
Getter method for the payment_method attribute.
public
getPaymentMethod() : PaymentMethod|null
Return values
PaymentMethod|null —getPrimaryPaymentMethod()
Getter method for the primary_payment_method attribute.
public
getPrimaryPaymentMethod() : bool|null
The primary_payment_method field is used to indicate the primary billing info on the account. The first billing info created on an account will always become primary. This payment method will be used
Return values
bool|null —getResponse()
Getter for the Recurly HTTP Response
public
getResponse() : Response
Return values
Response —The Recurly HTTP Response
getUpdatedAt()
Getter method for the updated_at attribute.
public
getUpdatedAt() : string|null
When the billing information was last changed.
Return values
string|null —getUpdatedBy()
Getter method for the updated_by attribute.
public
getUpdatedBy() : BillingInfoUpdatedBy|null
Return values
BillingInfoUpdatedBy|null —getValid()
Getter method for the valid attribute.
public
getValid() : bool|null
Return values
bool|null —getVatNumber()
Getter method for the vat_number attribute.
public
getVatNumber() : string|null
Customer's VAT number (to avoid having the VAT applied). This is only used for automatically collected invoices.
Return values
string|null —setAccountId()
Setter method for the account_id attribute.
public
setAccountId(string $account_id) : void
Parameters
- $account_id : string
Return values
void —setAddress()
Setter method for the address attribute.
public
setAddress(Address $address) : void
Parameters
- $address : Address
Return values
void —setBackupPaymentMethod()
Setter method for the backup_payment_method attribute.
public
setBackupPaymentMethod(bool $backup_payment_method) : void
Parameters
- $backup_payment_method : bool
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 —setFirstName()
Setter method for the first_name attribute.
public
setFirstName(string $first_name) : void
Parameters
- $first_name : string
Return values
void —setFraud()
Setter method for the fraud attribute.
public
setFraud(FraudInfo $fraud) : void
Parameters
- $fraud : FraudInfo
Return values
void —setId()
Setter method for the id attribute.
public
setId(string $id) : void
Parameters
- $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 —setPaymentMethod()
Setter method for the payment_method attribute.
public
setPaymentMethod(PaymentMethod $payment_method) : void
Parameters
- $payment_method : PaymentMethod
Return values
void —setPrimaryPaymentMethod()
Setter method for the primary_payment_method attribute.
public
setPrimaryPaymentMethod(bool $primary_payment_method) : void
Parameters
- $primary_payment_method : 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 —setUpdatedBy()
Setter method for the updated_by attribute.
public
setUpdatedBy(BillingInfoUpdatedBy $updated_by) : void
Parameters
- $updated_by : BillingInfoUpdatedBy
Return values
void —setValid()
Setter method for the valid attribute.
public
setValid(bool $valid) : void
Parameters
- $valid : bool
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