SubscriptionAddOnTier extends RecurlyResource
Table of Contents
- $array_hints : mixed
- $_ending_quantity : mixed
- $_response : mixed
- $_unit_amount : mixed
- $_unit_amount_decimal : mixed
- $_usage_percentage : 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.
- getEndingQuantity() : int|null
- Getter method for the ending_quantity attribute.
- getResponse() : Response
- Getter for the Recurly HTTP Response
- getUnitAmount() : float|null
- Getter method for the unit_amount attribute.
- getUnitAmountDecimal() : string|null
- Getter method for the unit_amount_decimal attribute.
- getUsagePercentage() : string|null
- Getter method for the usage_percentage attribute.
- setEndingQuantity() : void
- Setter method for the ending_quantity attribute.
- setUnitAmount() : void
- Setter method for the unit_amount attribute.
- setUnitAmountDecimal() : void
- Setter method for the unit_amount_decimal attribute.
- setUsagePercentage() : void
- Setter method for the usage_percentage 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
= []
$_ending_quantity
private
mixed
$_ending_quantity
$_response
private
mixed
$_response
$_unit_amount
private
mixed
$_unit_amount
$_unit_amount_decimal
private
mixed
$_unit_amount_decimal
$_usage_percentage
private
mixed
$_usage_percentage
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
getEndingQuantity()
Getter method for the ending_quantity attribute.
public
getEndingQuantity() : int|null
Ending quantity for the tier. This represents a unit amount for unit-priced add ons. Must be left empty if it is the final tier.
Return values
int|null —getResponse()
Getter for the Recurly HTTP Response
public
getResponse() : Response
Return values
Response —The Recurly HTTP Response
getUnitAmount()
Getter method for the unit_amount attribute.
public
getUnitAmount() : float|null
Allows up to 2 decimal places. Optionally, override the tiers' default unit amount. If add-on's add_on_type is usage and usage_type is percentage, cannot be provided.
Return values
float|null —getUnitAmountDecimal()
Getter method for the unit_amount_decimal attribute.
public
getUnitAmountDecimal() : string|null
Allows up to 9 decimal places. Optionally, override tiers' default unit amount.
If unit_amount_decimal is provided, unit_amount cannot be provided.
If add-on's add_on_type is usage and usage_type is percentage, cannot be provided.
Return values
string|null —getUsagePercentage()
Getter method for the usage_percentage attribute.
public
getUsagePercentage() : string|null
(deprecated) -- Use the percentage_tiers object instead.
Return values
string|null —setEndingQuantity()
Setter method for the ending_quantity attribute.
public
setEndingQuantity(int $ending_quantity) : void
Parameters
- $ending_quantity : int
Return values
void —setUnitAmount()
Setter method for the unit_amount attribute.
public
setUnitAmount(float $unit_amount) : void
Parameters
- $unit_amount : float
Return values
void —setUnitAmountDecimal()
Setter method for the unit_amount_decimal attribute.
public
setUnitAmountDecimal(string $unit_amount_decimal) : void
Parameters
- $unit_amount_decimal : string
Return values
void —setUsagePercentage()
Setter method for the usage_percentage attribute.
public
setUsagePercentage(string $usage_percentage) : void
Parameters
- $usage_percentage : 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