Recurly v3 API

SubscriptionChange extends RecurlyResource

Table of Contents

$array_hints  : mixed
$_activate_at  : mixed
$_activated  : mixed
$_add_ons  : mixed
$_billing_info  : mixed
$_business_entity  : mixed
$_created_at  : mixed
$_custom_fields  : mixed
$_deleted_at  : mixed
$_id  : mixed
$_invoice_collection  : mixed
$_object  : mixed
$_plan  : mixed
$_quantity  : mixed
$_ramp_intervals  : mixed
$_response  : mixed
$_revenue_schedule_type  : mixed
$_shipping  : mixed
$_subscription_id  : mixed
$_tax_inclusive  : mixed
$_unit_amount  : 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.
getActivateAt()  : string|null
Getter method for the activate_at attribute.
getActivated()  : bool|null
Getter method for the activated attribute.
getAddOns()  : array<string|int, mixed>
Getter method for the add_ons attribute.
getBillingInfo()  : SubscriptionChangeBillingInfo|null
Getter method for the billing_info attribute.
getBusinessEntity()  : BusinessEntityMini|null
Getter method for the business_entity 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.
getId()  : string|null
Getter method for the id attribute.
getInvoiceCollection()  : InvoiceCollection|null
Getter method for the invoice_collection attribute.
getObject()  : string|null
Getter method for the object attribute.
getPlan()  : PlanMini|null
Getter method for the plan attribute.
getQuantity()  : int|null
Getter method for the quantity attribute.
getRampIntervals()  : array<string|int, mixed>
Getter method for the ramp_intervals attribute.
getResponse()  : Response
Getter for the Recurly HTTP Response
getRevenueScheduleType()  : string|null
Getter method for the revenue_schedule_type attribute.
getShipping()  : SubscriptionShipping|null
Getter method for the shipping attribute.
getSubscriptionId()  : string|null
Getter method for the subscription_id attribute.
getTaxInclusive()  : bool|null
Getter method for the tax_inclusive attribute.
getUnitAmount()  : float|null
Getter method for the unit_amount attribute.
getUpdatedAt()  : string|null
Getter method for the updated_at attribute.
setActivateAt()  : void
Setter method for the activate_at attribute.
setActivated()  : void
Setter method for the activated attribute.
setAddOns()  : void
Setter method for the add_ons attribute.
setBillingInfo()  : void
Setter method for the billing_info attribute.
setBusinessEntity()  : void
Setter method for the business_entity 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.
setId()  : void
Setter method for the id attribute.
setInvoiceCollection()  : void
Setter method for the invoice_collection attribute.
setObject()  : void
Setter method for the object attribute.
setPlan()  : void
Setter method for the plan attribute.
setQuantity()  : void
Setter method for the quantity attribute.
setRampIntervals()  : void
Setter method for the ramp_intervals attribute.
setRevenueScheduleType()  : void
Setter method for the revenue_schedule_type attribute.
setShipping()  : void
Setter method for the shipping attribute.
setSubscriptionId()  : void
Setter method for the subscription_id attribute.
setTaxInclusive()  : void
Setter method for the tax_inclusive attribute.
setUnitAmount()  : void
Setter method for the unit_amount 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 = ['setAddOns' => '\Recurly\Resources\SubscriptionAddOn', 'setCustomFields' => '\Recurly\Resources\CustomField', 'setRampIntervals' => '\Recurly\Resources\SubscriptionRampIntervalResponse']

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

getActivateAt()

Getter method for the activate_at attribute.

public getActivateAt() : string|null

Activated at

Return values
string|null —

getActivated()

Getter method for the activated attribute.

public getActivated() : bool|null

Returns true if the subscription change is activated.

Return values
bool|null —

getAddOns()

Getter method for the add_ons attribute.

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

These add-ons will be used when the subscription renews.

Return values
array<string|int, mixed> —

getCreatedAt()

Getter method for the created_at attribute.

public getCreatedAt() : string|null

Created at

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

Deleted at

Return values
string|null —

getId()

Getter method for the id attribute.

public getId() : string|null

The ID of the Subscription Change.

Return values
string|null —

getObject()

Getter method for the object attribute.

public getObject() : string|null

Object type

Return values
string|null —

getQuantity()

Getter method for the quantity attribute.

public getQuantity() : int|null

Subscription quantity

Return values
int|null —

getRampIntervals()

Getter method for the ramp_intervals attribute.

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

The ramp intervals representing the pricing schedule for the subscription.

Return values
array<string|int, mixed> —

getRevenueScheduleType()

Getter method for the revenue_schedule_type attribute.

public getRevenueScheduleType() : string|null

Revenue schedule type

Return values
string|null —

getSubscriptionId()

Getter method for the subscription_id attribute.

public getSubscriptionId() : string|null

The ID of the subscription that is going to be changed.

Return values
string|null —

getTaxInclusive()

Getter method for the tax_inclusive attribute.

public getTaxInclusive() : bool|null

This field is deprecated. Please do not use it.

Return values
bool|null —

getUnitAmount()

Getter method for the unit_amount attribute.

public getUnitAmount() : float|null

Unit amount

Return values
float|null —

getUpdatedAt()

Getter method for the updated_at attribute.

public getUpdatedAt() : string|null

Updated at

Return values
string|null —

setActivateAt()

Setter method for the activate_at attribute.

public setActivateAt(string $activate_at) : void
Parameters
$activate_at : string
Return values
void —

setActivated()

Setter method for the activated attribute.

public setActivated(bool $activated) : void
Parameters
$activated : bool
Return values
void —

setAddOns()

Setter method for the add_ons attribute.

public setAddOns(array<string|int, mixed> $add_ons) : void
Parameters
$add_ons : array<string|int, mixed>
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 —

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 —

setQuantity()

Setter method for the quantity attribute.

public setQuantity(int $quantity) : void
Parameters
$quantity : int
Return values
void —

setRampIntervals()

Setter method for the ramp_intervals attribute.

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

setRevenueScheduleType()

Setter method for the revenue_schedule_type attribute.

public setRevenueScheduleType(string $revenue_schedule_type) : void
Parameters
$revenue_schedule_type : string
Return values
void —

setSubscriptionId()

Setter method for the subscription_id attribute.

public setSubscriptionId(string $subscription_id) : void
Parameters
$subscription_id : string
Return values
void —

setTaxInclusive()

Setter method for the tax_inclusive attribute.

public setTaxInclusive(bool $tax_inclusive) : void
Parameters
$tax_inclusive : bool
Return values
void —

setUnitAmount()

Setter method for the unit_amount attribute.

public setUnitAmount(float $unit_amount) : void
Parameters
$unit_amount : float
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

Search results