ExternalPaymentPhase extends RecurlyResource
Table of Contents
- $array_hints : mixed
- $_amount : mixed
- $_created_at : mixed
- $_currency : mixed
- $_ending_billing_period_index : mixed
- $_ends_at : mixed
- $_id : mixed
- $_object : mixed
- $_offer_name : mixed
- $_offer_type : mixed
- $_period_count : mixed
- $_period_length : mixed
- $_response : mixed
- $_started_at : mixed
- $_starting_billing_period_index : mixed
- $_updated_at : 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.
- getAmount() : string|null
- Getter method for the amount attribute.
- getCreatedAt() : string|null
- Getter method for the created_at attribute.
- getCurrency() : string|null
- Getter method for the currency attribute.
- getEndingBillingPeriodIndex() : int|null
- Getter method for the ending_billing_period_index attribute.
- getEndsAt() : string|null
- Getter method for the ends_at attribute.
- getId() : string|null
- Getter method for the id attribute.
- getObject() : string|null
- Getter method for the object attribute.
- getOfferName() : string|null
- Getter method for the offer_name attribute.
- getOfferType() : string|null
- Getter method for the offer_type attribute.
- getPeriodCount() : int|null
- Getter method for the period_count attribute.
- getPeriodLength() : string|null
- Getter method for the period_length attribute.
- getResponse() : Response
- Getter for the Recurly HTTP Response
- getStartedAt() : string|null
- Getter method for the started_at attribute.
- getStartingBillingPeriodIndex() : int|null
- Getter method for the starting_billing_period_index attribute.
- getUpdatedAt() : string|null
- Getter method for the updated_at attribute.
- setAmount() : void
- Setter method for the amount attribute.
- setCreatedAt() : void
- Setter method for the created_at attribute.
- setCurrency() : void
- Setter method for the currency attribute.
- setEndingBillingPeriodIndex() : void
- Setter method for the ending_billing_period_index attribute.
- setEndsAt() : void
- Setter method for the ends_at attribute.
- setId() : void
- Setter method for the id attribute.
- setObject() : void
- Setter method for the object attribute.
- setOfferName() : void
- Setter method for the offer_name attribute.
- setOfferType() : void
- Setter method for the offer_type attribute.
- setPeriodCount() : void
- Setter method for the period_count attribute.
- setPeriodLength() : void
- Setter method for the period_length attribute.
- setStartedAt() : void
- Setter method for the started_at attribute.
- setStartingBillingPeriodIndex() : void
- Setter method for the starting_billing_period_index attribute.
- setUpdatedAt() : void
- Setter method for the updated_at 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
= []
$_amount
private
mixed
$_amount
$_created_at
private
mixed
$_created_at
$_currency
private
mixed
$_currency
$_ending_billing_period_index
private
mixed
$_ending_billing_period_index
$_ends_at
private
mixed
$_ends_at
$_id
private
mixed
$_id
$_object
private
mixed
$_object
$_offer_name
private
mixed
$_offer_name
$_offer_type
private
mixed
$_offer_type
$_period_count
private
mixed
$_period_count
$_period_length
private
mixed
$_period_length
$_response
private
mixed
$_response
$_started_at
private
mixed
$_started_at
$_starting_billing_period_index
private
mixed
$_starting_billing_period_index
$_updated_at
private
mixed
$_updated_at
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
getAmount()
Getter method for the amount attribute.
public
getAmount() : string|null
Allows up to 9 decimal places
Return values
string|null —getCreatedAt()
Getter method for the created_at attribute.
public
getCreatedAt() : string|null
When the external subscription was created in Recurly.
Return values
string|null —getCurrency()
Getter method for the currency attribute.
public
getCurrency() : string|null
3-letter ISO 4217 currency code.
Return values
string|null —getEndingBillingPeriodIndex()
Getter method for the ending_billing_period_index attribute.
public
getEndingBillingPeriodIndex() : int|null
Ending Billing Period Index
Return values
int|null —getEndsAt()
Getter method for the ends_at attribute.
public
getEndsAt() : string|null
Ends At
Return values
string|null —getId()
Getter method for the id attribute.
public
getId() : string|null
System-generated unique identifier for an external payment phase ID, e.g. e28zov4fw0v2.
Return values
string|null —getObject()
Getter method for the object attribute.
public
getObject() : string|null
Object type
Return values
string|null —getOfferName()
Getter method for the offer_name attribute.
public
getOfferName() : string|null
Name of the discount offer given, e.g. "introductory"
Return values
string|null —getOfferType()
Getter method for the offer_type attribute.
public
getOfferType() : string|null
Type of discount offer given, e.g. "FREE_TRIAL"
Return values
string|null —getPeriodCount()
Getter method for the period_count attribute.
public
getPeriodCount() : int|null
Number of billing periods
Return values
int|null —getPeriodLength()
Getter method for the period_length attribute.
public
getPeriodLength() : string|null
Billing cycle length
Return values
string|null —getResponse()
Getter for the Recurly HTTP Response
public
getResponse() : Response
Return values
Response —The Recurly HTTP Response
getStartedAt()
Getter method for the started_at attribute.
public
getStartedAt() : string|null
Started At
Return values
string|null —getStartingBillingPeriodIndex()
Getter method for the starting_billing_period_index attribute.
public
getStartingBillingPeriodIndex() : int|null
Starting Billing Period Index
Return values
int|null —getUpdatedAt()
Getter method for the updated_at attribute.
public
getUpdatedAt() : string|null
When the external subscription was updated in Recurly.
Return values
string|null —setAmount()
Setter method for the amount attribute.
public
setAmount(string $amount) : void
Parameters
- $amount : 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 —setCurrency()
Setter method for the currency attribute.
public
setCurrency(string $currency) : void
Parameters
- $currency : string
Return values
void —setEndingBillingPeriodIndex()
Setter method for the ending_billing_period_index attribute.
public
setEndingBillingPeriodIndex(int $ending_billing_period_index) : void
Parameters
- $ending_billing_period_index : int
Return values
void —setEndsAt()
Setter method for the ends_at attribute.
public
setEndsAt(string $ends_at) : void
Parameters
- $ends_at : string
Return values
void —setId()
Setter method for the id attribute.
public
setId(string $id) : void
Parameters
- $id : string
Return values
void —setObject()
Setter method for the object attribute.
public
setObject(string $object) : void
Parameters
- $object : string
Return values
void —setOfferName()
Setter method for the offer_name attribute.
public
setOfferName(string $offer_name) : void
Parameters
- $offer_name : string
Return values
void —setOfferType()
Setter method for the offer_type attribute.
public
setOfferType(string $offer_type) : void
Parameters
- $offer_type : string
Return values
void —setPeriodCount()
Setter method for the period_count attribute.
public
setPeriodCount(int $period_count) : void
Parameters
- $period_count : int
Return values
void —setPeriodLength()
Setter method for the period_length attribute.
public
setPeriodLength(string $period_length) : void
Parameters
- $period_length : string
Return values
void —setStartedAt()
Setter method for the started_at attribute.
public
setStartedAt(string $started_at) : void
Parameters
- $started_at : string
Return values
void —setStartingBillingPeriodIndex()
Setter method for the starting_billing_period_index attribute.
public
setStartingBillingPeriodIndex(int $starting_billing_period_index) : void
Parameters
- $starting_billing_period_index : int
Return values
void —setUpdatedAt()
Setter method for the updated_at attribute.
public
setUpdatedAt(string $updated_at) : void
Parameters
- $updated_at : 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