Invoice extends RecurlyResource
Table of Contents
- $array_hints : mixed
- $_account : mixed
- $_address : mixed
- $_balance : mixed
- $_billing_info_id : mixed
- $_business_entity_id : mixed
- $_closed_at : mixed
- $_collection_method : mixed
- $_created_at : mixed
- $_credit_payments : mixed
- $_currency : mixed
- $_customer_notes : mixed
- $_discount : mixed
- $_due_at : mixed
- $_dunning_campaign_id : mixed
- $_dunning_events_sent : mixed
- $_final_dunning_event : mixed
- $_has_more_line_items : mixed
- $_id : mixed
- $_line_items : mixed
- $_net_terms : mixed
- $_net_terms_type : mixed
- $_number : mixed
- $_object : mixed
- $_origin : mixed
- $_paid : mixed
- $_po_number : mixed
- $_previous_invoice_id : mixed
- $_refundable_amount : mixed
- $_response : mixed
- $_shipping_address : mixed
- $_state : mixed
- $_subscription_ids : mixed
- $_subtotal : mixed
- $_tax : mixed
- $_tax_info : mixed
- $_terms_and_conditions : mixed
- $_total : mixed
- $_transactions : mixed
- $_type : mixed
- $_updated_at : mixed
- $_used_tax_service : mixed
- $_uuid : mixed
- $_vat_number : mixed
- $_vat_reverse_charge_notes : 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.
- getAccount() : AccountMini|null
- Getter method for the account attribute.
- getAddress() : InvoiceAddress|null
- Getter method for the address attribute.
- getBalance() : float|null
- Getter method for the balance attribute.
- getBillingInfoId() : string|null
- Getter method for the billing_info_id attribute.
- getBusinessEntityId() : string|null
- Getter method for the business_entity_id attribute.
- getClosedAt() : string|null
- Getter method for the closed_at attribute.
- getCollectionMethod() : string|null
- Getter method for the collection_method attribute.
- getCreatedAt() : string|null
- Getter method for the created_at attribute.
- getCreditPayments() : array<string|int, mixed>
- Getter method for the credit_payments attribute.
- getCurrency() : string|null
- Getter method for the currency attribute.
- getCustomerNotes() : string|null
- Getter method for the customer_notes attribute.
- getDiscount() : float|null
- Getter method for the discount attribute.
- getDueAt() : string|null
- Getter method for the due_at attribute.
- getDunningCampaignId() : string|null
- Getter method for the dunning_campaign_id attribute.
- getDunningEventsSent() : int|null
- Getter method for the dunning_events_sent attribute.
- getFinalDunningEvent() : bool|null
- Getter method for the final_dunning_event attribute.
- getHasMoreLineItems() : bool|null
- Getter method for the has_more_line_items attribute.
- getId() : string|null
- Getter method for the id attribute.
- getLineItems() : array<string|int, mixed>
- Getter method for the line_items attribute.
- getNetTerms() : int|null
- Getter method for the net_terms attribute.
- getNetTermsType() : string|null
- Getter method for the net_terms_type attribute.
- getNumber() : string|null
- Getter method for the number attribute.
- getObject() : string|null
- Getter method for the object attribute.
- getOrigin() : string|null
- Getter method for the origin attribute.
- getPaid() : float|null
- Getter method for the paid attribute.
- getPoNumber() : string|null
- Getter method for the po_number attribute.
- getPreviousInvoiceId() : string|null
- Getter method for the previous_invoice_id attribute.
- getRefundableAmount() : float|null
- Getter method for the refundable_amount attribute.
- getResponse() : Response
- Getter for the Recurly HTTP Response
- getShippingAddress() : ShippingAddress|null
- Getter method for the shipping_address attribute.
- getState() : string|null
- Getter method for the state attribute.
- getSubscriptionIds() : array<string|int, mixed>
- Getter method for the subscription_ids attribute.
- getSubtotal() : float|null
- Getter method for the subtotal attribute.
- getTax() : float|null
- Getter method for the tax attribute.
- getTaxInfo() : TaxInfo|null
- Getter method for the tax_info attribute.
- getTermsAndConditions() : string|null
- Getter method for the terms_and_conditions attribute.
- getTotal() : float|null
- Getter method for the total attribute.
- getTransactions() : array<string|int, mixed>
- Getter method for the transactions attribute.
- getType() : string|null
- Getter method for the type attribute.
- getUpdatedAt() : string|null
- Getter method for the updated_at attribute.
- getUsedTaxService() : bool|null
- Getter method for the used_tax_service attribute.
- getUuid() : string|null
- Getter method for the uuid attribute.
- getVatNumber() : string|null
- Getter method for the vat_number attribute.
- getVatReverseChargeNotes() : string|null
- Getter method for the vat_reverse_charge_notes attribute.
- setAccount() : void
- Setter method for the account attribute.
- setAddress() : void
- Setter method for the address attribute.
- setBalance() : void
- Setter method for the balance attribute.
- setBillingInfoId() : void
- Setter method for the billing_info_id attribute.
- setBusinessEntityId() : void
- Setter method for the business_entity_id attribute.
- setClosedAt() : void
- Setter method for the closed_at attribute.
- setCollectionMethod() : void
- Setter method for the collection_method attribute.
- setCreatedAt() : void
- Setter method for the created_at attribute.
- setCreditPayments() : void
- Setter method for the credit_payments attribute.
- setCurrency() : void
- Setter method for the currency attribute.
- setCustomerNotes() : void
- Setter method for the customer_notes attribute.
- setDiscount() : void
- Setter method for the discount attribute.
- setDueAt() : void
- Setter method for the due_at attribute.
- setDunningCampaignId() : void
- Setter method for the dunning_campaign_id attribute.
- setDunningEventsSent() : void
- Setter method for the dunning_events_sent attribute.
- setFinalDunningEvent() : void
- Setter method for the final_dunning_event attribute.
- setHasMoreLineItems() : void
- Setter method for the has_more_line_items attribute.
- setId() : void
- Setter method for the id attribute.
- setLineItems() : void
- Setter method for the line_items attribute.
- setNetTerms() : void
- Setter method for the net_terms attribute.
- setNetTermsType() : void
- Setter method for the net_terms_type attribute.
- setNumber() : void
- Setter method for the number attribute.
- setObject() : void
- Setter method for the object attribute.
- setOrigin() : void
- Setter method for the origin attribute.
- setPaid() : void
- Setter method for the paid attribute.
- setPoNumber() : void
- Setter method for the po_number attribute.
- setPreviousInvoiceId() : void
- Setter method for the previous_invoice_id attribute.
- setRefundableAmount() : void
- Setter method for the refundable_amount attribute.
- setShippingAddress() : void
- Setter method for the shipping_address attribute.
- setState() : void
- Setter method for the state attribute.
- setSubscriptionIds() : void
- Setter method for the subscription_ids attribute.
- setSubtotal() : void
- Setter method for the subtotal attribute.
- setTax() : void
- Setter method for the tax attribute.
- setTaxInfo() : void
- Setter method for the tax_info attribute.
- setTermsAndConditions() : void
- Setter method for the terms_and_conditions attribute.
- setTotal() : void
- Setter method for the total attribute.
- setTransactions() : void
- Setter method for the transactions attribute.
- setType() : void
- Setter method for the type attribute.
- setUpdatedAt() : void
- Setter method for the updated_at attribute.
- setUsedTaxService() : void
- Setter method for the used_tax_service attribute.
- setUuid() : void
- Setter method for the uuid attribute.
- setVatNumber() : void
- Setter method for the vat_number attribute.
- setVatReverseChargeNotes() : void
- Setter method for the vat_reverse_charge_notes 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
= ['setCreditPayments' => '\Recurly\Resources\CreditPayment', 'setLineItems' => '\Recurly\Resources\LineItem', 'setSubscriptionIds' => 'string', 'setTransactions' => '\Recurly\Resources\Transaction']
$_account
private
mixed
$_account
$_address
private
mixed
$_address
$_balance
private
mixed
$_balance
$_billing_info_id
private
mixed
$_billing_info_id
$_business_entity_id
private
mixed
$_business_entity_id
$_closed_at
private
mixed
$_closed_at
$_collection_method
private
mixed
$_collection_method
$_created_at
private
mixed
$_created_at
$_credit_payments
private
mixed
$_credit_payments
$_currency
private
mixed
$_currency
$_customer_notes
private
mixed
$_customer_notes
$_discount
private
mixed
$_discount
$_due_at
private
mixed
$_due_at
$_dunning_campaign_id
private
mixed
$_dunning_campaign_id
$_dunning_events_sent
private
mixed
$_dunning_events_sent
$_final_dunning_event
private
mixed
$_final_dunning_event
$_has_more_line_items
private
mixed
$_has_more_line_items
$_id
private
mixed
$_id
$_line_items
private
mixed
$_line_items
$_net_terms
private
mixed
$_net_terms
$_net_terms_type
private
mixed
$_net_terms_type
$_number
private
mixed
$_number
$_object
private
mixed
$_object
$_origin
private
mixed
$_origin
$_paid
private
mixed
$_paid
$_po_number
private
mixed
$_po_number
$_previous_invoice_id
private
mixed
$_previous_invoice_id
$_refundable_amount
private
mixed
$_refundable_amount
$_response
private
mixed
$_response
$_shipping_address
private
mixed
$_shipping_address
$_state
private
mixed
$_state
$_subscription_ids
private
mixed
$_subscription_ids
$_subtotal
private
mixed
$_subtotal
$_tax
private
mixed
$_tax
$_tax_info
private
mixed
$_tax_info
$_terms_and_conditions
private
mixed
$_terms_and_conditions
$_total
private
mixed
$_total
$_transactions
private
mixed
$_transactions
$_type
private
mixed
$_type
$_updated_at
private
mixed
$_updated_at
$_used_tax_service
private
mixed
$_used_tax_service
$_uuid
private
mixed
$_uuid
$_vat_number
private
mixed
$_vat_number
$_vat_reverse_charge_notes
private
mixed
$_vat_reverse_charge_notes
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
getAccount()
Getter method for the account attribute.
public
getAccount() : AccountMini|null
Account mini details
Return values
AccountMini|null —getAddress()
Getter method for the address attribute.
public
getAddress() : InvoiceAddress|null
Return values
InvoiceAddress|null —getBalance()
Getter method for the balance attribute.
public
getBalance() : float|null
The outstanding balance remaining on this invoice.
Return values
float|null —getBillingInfoId()
Getter method for the billing_info_id attribute.
public
getBillingInfoId() : string|null
The billing_info_id is the value that represents a specific billing info for an end customer. When billing_info_id is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. billing_info_id can ONLY be used for sites utilizing the Wallet feature.
Return values
string|null —getBusinessEntityId()
Getter method for the business_entity_id attribute.
public
getBusinessEntityId() : string|null
Unique ID to identify the business entity assigned to the invoice. Available when the Multiple Business Entities feature is enabled.
Return values
string|null —getClosedAt()
Getter method for the closed_at attribute.
public
getClosedAt() : string|null
Date invoice was marked paid or failed.
Return values
string|null —getCollectionMethod()
Getter method for the collection_method attribute.
public
getCollectionMethod() : string|null
An automatic invoice means a corresponding transaction is run using the account's billing information at the same time the invoice is created. Manual invoices are created without a corresponding transaction. The merchant must enter a manual payment transaction or have the customer pay the invoice with an automatic method, like credit card, PayPal, Amazon, or ACH bank payment.
Return values
string|null —getCreatedAt()
Getter method for the created_at attribute.
public
getCreatedAt() : string|null
Created at
Return values
string|null —getCreditPayments()
Getter method for the credit_payments attribute.
public
getCreditPayments() : array<string|int, mixed>
Credit payments
Return values
array<string|int, mixed> —getCurrency()
Getter method for the currency attribute.
public
getCurrency() : string|null
3-letter ISO 4217 currency code.
Return values
string|null —getCustomerNotes()
Getter method for the customer_notes attribute.
public
getCustomerNotes() : string|null
This will default to the Customer Notes text specified on the Invoice Settings. Specify custom notes to add or override Customer Notes.
Return values
string|null —getDiscount()
Getter method for the discount attribute.
public
getDiscount() : float|null
Total discounts applied to this invoice.
Return values
float|null —getDueAt()
Getter method for the due_at attribute.
public
getDueAt() : string|null
Date invoice is due. This is the date the net terms are reached.
Return values
string|null —getDunningCampaignId()
Getter method for the dunning_campaign_id attribute.
public
getDunningCampaignId() : string|null
Unique ID to identify the dunning campaign used when dunning the invoice. For sites without multiple dunning campaigns enabled, this will always be the default dunning campaign.
Return values
string|null —getDunningEventsSent()
Getter method for the dunning_events_sent attribute.
public
getDunningEventsSent() : int|null
Number of times the event was sent.
Return values
int|null —getFinalDunningEvent()
Getter method for the final_dunning_event attribute.
public
getFinalDunningEvent() : bool|null
Last communication attempt.
Return values
bool|null —getHasMoreLineItems()
Getter method for the has_more_line_items attribute.
public
getHasMoreLineItems() : bool|null
Identifies if the invoice has more line items than are returned in line_items. If has_more_line_items is true, then a request needs to be made to the list_invoice_line_items endpoint.
Return values
bool|null —getId()
Getter method for the id attribute.
public
getId() : string|null
Invoice ID
Return values
string|null —getLineItems()
Getter method for the line_items attribute.
public
getLineItems() : array<string|int, mixed>
Line Items
Return values
array<string|int, mixed> —getNetTerms()
Getter method for the net_terms attribute.
public
getNetTerms() : int|null
Integer paired with Net Terms Type and representing the number
of days past the current date (for net Net Terms Type) or days after
the last day of the current month (for eom Net Terms Type) that the
invoice will become past due. For manual collection method, an additional 24 hours is
added to ensure the customer has the entire last day to make payment before
becoming past due. For example:
If an invoice is due net 0, it is due 'On Receipt' and will become past due 24 hours after it's created.
If an invoice is due net 30, it will become past due at 31 days exactly.
If an invoice is due eom 30, it will become past due 31 days from the last day of the current month.
For automatic collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and net 30 will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection.
When eom Net Terms Type is passed, the value for Net Terms is restricted to 0, 15, 30, 45, 60, or 90.
For more information on how net terms work with manual collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using automatic collection.
Return values
int|null —getNetTermsType()
Getter method for the net_terms_type attribute.
public
getNetTermsType() : string|null
Optionally supplied string that may be either net or eom (end-of-month).
When net, an invoice becomes past due the specified number of Net Terms days from the current date.
When eom an invoice becomes past due the specified number of Net Terms days from the last day of the current month.
Return values
string|null —getNumber()
Getter method for the number attribute.
public
getNumber() : string|null
If VAT taxation and the Country Invoice Sequencing feature are enabled, invoices will have country-specific invoice numbers for invoices billed to EU countries (ex: FR1001). Non-EU invoices will continue to use the site-level invoice number sequence.
Return values
string|null —getObject()
Getter method for the object attribute.
public
getObject() : string|null
Object type
Return values
string|null —getOrigin()
Getter method for the origin attribute.
public
getOrigin() : string|null
The event that created the invoice.
Return values
string|null —getPaid()
Getter method for the paid attribute.
public
getPaid() : float|null
The total amount of successful payments transaction on this invoice.
Return values
float|null —getPoNumber()
Getter method for the po_number attribute.
public
getPoNumber() : string|null
For manual invoicing, this identifies the PO number associated with the subscription.
Return values
string|null —getPreviousInvoiceId()
Getter method for the previous_invoice_id attribute.
public
getPreviousInvoiceId() : string|null
On refund invoices, this value will exist and show the invoice ID of the purchase invoice the refund was created from. This field is only populated for sites without the Only Bill What Changed feature enabled. Sites with Only Bill What Changed enabled should use the related_invoices endpoint to see purchase invoices refunded by this invoice.
Return values
string|null —getRefundableAmount()
Getter method for the refundable_amount attribute.
public
getRefundableAmount() : float|null
The refundable amount on a charge invoice. It will be null for all other invoices.
Return values
float|null —getResponse()
Getter for the Recurly HTTP Response
public
getResponse() : Response
Return values
Response —The Recurly HTTP Response
getShippingAddress()
Getter method for the shipping_address attribute.
public
getShippingAddress() : ShippingAddress|null
Return values
ShippingAddress|null —getState()
Getter method for the state attribute.
public
getState() : string|null
Invoice state
Return values
string|null —getSubscriptionIds()
Getter method for the subscription_ids attribute.
public
getSubscriptionIds() : array<string|int, mixed>
If the invoice is charging or refunding for one or more subscriptions, these are their IDs.
Return values
array<string|int, mixed> —getSubtotal()
Getter method for the subtotal attribute.
public
getSubtotal() : float|null
The summation of charges and credits, before discounts and taxes.
Return values
float|null —getTax()
Getter method for the tax attribute.
public
getTax() : float|null
The total tax on this invoice.
Return values
float|null —getTaxInfo()
Getter method for the tax_info attribute.
public
getTaxInfo() : TaxInfo|null
Only for merchants using Recurly's In-The-Box taxes.
Return values
TaxInfo|null —getTermsAndConditions()
Getter method for the terms_and_conditions attribute.
public
getTermsAndConditions() : string|null
This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Specify custom notes to add or override Terms and Conditions.
Return values
string|null —getTotal()
Getter method for the total attribute.
public
getTotal() : float|null
The final total on this invoice. The summation of invoice charges, discounts, credits, and tax.
Return values
float|null —getTransactions()
Getter method for the transactions attribute.
public
getTransactions() : array<string|int, mixed>
Transactions
Return values
array<string|int, mixed> —getType()
Getter method for the type attribute.
public
getType() : string|null
Invoices are either charge, credit, or legacy invoices.
Return values
string|null —getUpdatedAt()
Getter method for the updated_at attribute.
public
getUpdatedAt() : string|null
Last updated at
Return values
string|null —getUsedTaxService()
Getter method for the used_tax_service attribute.
public
getUsedTaxService() : bool|null
Will be true when the invoice had a successful response from the tax service and false when the invoice was not sent to tax service due to a lack of address or enabled jurisdiction or was processed without tax due to a non-blocking error returned from the tax service.
Return values
bool|null —getUuid()
Getter method for the uuid attribute.
public
getUuid() : string|null
Invoice UUID
Return values
string|null —getVatNumber()
Getter method for the vat_number attribute.
public
getVatNumber() : string|null
VAT registration number for the customer on this invoice. This will come from the VAT Number field in the Billing Info or the Account Info depending on your tax settings and the invoice collection method.
Return values
string|null —getVatReverseChargeNotes()
Getter method for the vat_reverse_charge_notes attribute.
public
getVatReverseChargeNotes() : string|null
VAT Reverse Charge Notes only appear if you have EU VAT enabled or are using your own Avalara AvaTax account and the customer is in the EU, has a VAT number, and is in a different country than your own. This will default to the VAT Reverse Charge Notes text specified on the Tax Settings page in your Recurly admin, unless custom notes were created with the original subscription.
Return values
string|null —setAccount()
Setter method for the account attribute.
public
setAccount(AccountMini $account) : void
Parameters
- $account : AccountMini
Return values
void —setAddress()
Setter method for the address attribute.
public
setAddress(InvoiceAddress $address) : void
Parameters
- $address : InvoiceAddress
Return values
void —setBalance()
Setter method for the balance attribute.
public
setBalance(float $balance) : void
Parameters
- $balance : float
Return values
void —setBillingInfoId()
Setter method for the billing_info_id attribute.
public
setBillingInfoId(string $billing_info_id) : void
Parameters
- $billing_info_id : string
Return values
void —setBusinessEntityId()
Setter method for the business_entity_id attribute.
public
setBusinessEntityId(string $business_entity_id) : void
Parameters
- $business_entity_id : string
Return values
void —setClosedAt()
Setter method for the closed_at attribute.
public
setClosedAt(string $closed_at) : void
Parameters
- $closed_at : string
Return values
void —setCollectionMethod()
Setter method for the collection_method attribute.
public
setCollectionMethod(string $collection_method) : void
Parameters
- $collection_method : 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 —setCreditPayments()
Setter method for the credit_payments attribute.
public
setCreditPayments(array<string|int, mixed> $credit_payments) : void
Parameters
- $credit_payments : array<string|int, mixed>
Return values
void —setCurrency()
Setter method for the currency attribute.
public
setCurrency(string $currency) : void
Parameters
- $currency : string
Return values
void —setCustomerNotes()
Setter method for the customer_notes attribute.
public
setCustomerNotes(string $customer_notes) : void
Parameters
- $customer_notes : string
Return values
void —setDiscount()
Setter method for the discount attribute.
public
setDiscount(float $discount) : void
Parameters
- $discount : float
Return values
void —setDueAt()
Setter method for the due_at attribute.
public
setDueAt(string $due_at) : void
Parameters
- $due_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 —setDunningEventsSent()
Setter method for the dunning_events_sent attribute.
public
setDunningEventsSent(int $dunning_events_sent) : void
Parameters
- $dunning_events_sent : int
Return values
void —setFinalDunningEvent()
Setter method for the final_dunning_event attribute.
public
setFinalDunningEvent(bool $final_dunning_event) : void
Parameters
- $final_dunning_event : bool
Return values
void —setHasMoreLineItems()
Setter method for the has_more_line_items attribute.
public
setHasMoreLineItems(bool $has_more_line_items) : void
Parameters
- $has_more_line_items : bool
Return values
void —setId()
Setter method for the id attribute.
public
setId(string $id) : void
Parameters
- $id : string
Return values
void —setLineItems()
Setter method for the line_items attribute.
public
setLineItems(array<string|int, mixed> $line_items) : void
Parameters
- $line_items : array<string|int, mixed>
Return values
void —setNetTerms()
Setter method for the net_terms attribute.
public
setNetTerms(int $net_terms) : void
Parameters
- $net_terms : int
Return values
void —setNetTermsType()
Setter method for the net_terms_type attribute.
public
setNetTermsType(string $net_terms_type) : void
Parameters
- $net_terms_type : string
Return values
void —setNumber()
Setter method for the number attribute.
public
setNumber(string $number) : void
Parameters
- $number : string
Return values
void —setObject()
Setter method for the object attribute.
public
setObject(string $object) : void
Parameters
- $object : string
Return values
void —setOrigin()
Setter method for the origin attribute.
public
setOrigin(string $origin) : void
Parameters
- $origin : string
Return values
void —setPaid()
Setter method for the paid attribute.
public
setPaid(float $paid) : void
Parameters
- $paid : float
Return values
void —setPoNumber()
Setter method for the po_number attribute.
public
setPoNumber(string $po_number) : void
Parameters
- $po_number : string
Return values
void —setPreviousInvoiceId()
Setter method for the previous_invoice_id attribute.
public
setPreviousInvoiceId(string $previous_invoice_id) : void
Parameters
- $previous_invoice_id : string
Return values
void —setRefundableAmount()
Setter method for the refundable_amount attribute.
public
setRefundableAmount(float $refundable_amount) : void
Parameters
- $refundable_amount : float
Return values
void —setShippingAddress()
Setter method for the shipping_address attribute.
public
setShippingAddress(ShippingAddress $shipping_address) : void
Parameters
- $shipping_address : ShippingAddress
Return values
void —setState()
Setter method for the state attribute.
public
setState(string $state) : void
Parameters
- $state : string
Return values
void —setSubscriptionIds()
Setter method for the subscription_ids attribute.
public
setSubscriptionIds(array<string|int, mixed> $subscription_ids) : void
Parameters
- $subscription_ids : array<string|int, mixed>
Return values
void —setSubtotal()
Setter method for the subtotal attribute.
public
setSubtotal(float $subtotal) : void
Parameters
- $subtotal : float
Return values
void —setTax()
Setter method for the tax attribute.
public
setTax(float $tax) : void
Parameters
- $tax : float
Return values
void —setTaxInfo()
Setter method for the tax_info attribute.
public
setTaxInfo(TaxInfo $tax_info) : void
Parameters
- $tax_info : TaxInfo
Return values
void —setTermsAndConditions()
Setter method for the terms_and_conditions attribute.
public
setTermsAndConditions(string $terms_and_conditions) : void
Parameters
- $terms_and_conditions : string
Return values
void —setTotal()
Setter method for the total attribute.
public
setTotal(float $total) : void
Parameters
- $total : float
Return values
void —setTransactions()
Setter method for the transactions attribute.
public
setTransactions(array<string|int, mixed> $transactions) : void
Parameters
- $transactions : array<string|int, mixed>
Return values
void —setType()
Setter method for the type attribute.
public
setType(string $type) : void
Parameters
- $type : string
Return values
void —setUpdatedAt()
Setter method for the updated_at attribute.
public
setUpdatedAt(string $updated_at) : void
Parameters
- $updated_at : string
Return values
void —setUsedTaxService()
Setter method for the used_tax_service attribute.
public
setUsedTaxService(bool $used_tax_service) : void
Parameters
- $used_tax_service : bool
Return values
void —setUuid()
Setter method for the uuid attribute.
public
setUuid(string $uuid) : void
Parameters
- $uuid : 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 —setVatReverseChargeNotes()
Setter method for the vat_reverse_charge_notes attribute.
public
setVatReverseChargeNotes(string $vat_reverse_charge_notes) : void
Parameters
- $vat_reverse_charge_notes : 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