Recurly v3 API

Plan extends RecurlyResource

Table of Contents

$array_hints  : mixed
$_accounting_code  : mixed
$_allow_any_item_on_subscriptions  : mixed
$_auto_renew  : mixed
$_avalara_service_type  : mixed
$_avalara_transaction_type  : mixed
$_code  : mixed
$_created_at  : mixed
$_currencies  : mixed
$_custom_fields  : mixed
$_deleted_at  : mixed
$_description  : mixed
$_dunning_campaign_id  : mixed
$_hosted_pages  : mixed
$_id  : mixed
$_interval_length  : mixed
$_interval_unit  : mixed
$_name  : mixed
$_object  : mixed
$_pricing_model  : mixed
$_ramp_intervals  : mixed
$_response  : mixed
$_revenue_schedule_type  : mixed
$_setup_fee_accounting_code  : mixed
$_setup_fee_revenue_schedule_type  : mixed
$_state  : mixed
$_tax_code  : mixed
$_tax_exempt  : mixed
$_total_billing_cycles  : mixed
$_trial_length  : mixed
$_trial_requires_billing_info  : mixed
$_trial_unit  : mixed
$_updated_at  : mixed
$_vertex_transaction_type  : 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.
getAccountingCode()  : string|null
Getter method for the accounting_code attribute.
getAllowAnyItemOnSubscriptions()  : bool|null
Getter method for the allow_any_item_on_subscriptions attribute.
getAutoRenew()  : bool|null
Getter method for the auto_renew attribute.
getAvalaraServiceType()  : int|null
Getter method for the avalara_service_type attribute.
getAvalaraTransactionType()  : int|null
Getter method for the avalara_transaction_type attribute.
getCode()  : string|null
Getter method for the code attribute.
getCreatedAt()  : string|null
Getter method for the created_at attribute.
getCurrencies()  : array<string|int, mixed>
Getter method for the currencies attribute.
getCustomFields()  : array<string|int, mixed>
Getter method for the custom_fields attribute.
getDeletedAt()  : string|null
Getter method for the deleted_at attribute.
getDescription()  : string|null
Getter method for the description attribute.
getDunningCampaignId()  : string|null
Getter method for the dunning_campaign_id attribute.
getHostedPages()  : PlanHostedPages|null
Getter method for the hosted_pages attribute.
getId()  : string|null
Getter method for the id attribute.
getIntervalLength()  : int|null
Getter method for the interval_length attribute.
getIntervalUnit()  : string|null
Getter method for the interval_unit attribute.
getName()  : string|null
Getter method for the name attribute.
getObject()  : string|null
Getter method for the object attribute.
getPricingModel()  : string|null
Getter method for the pricing_model 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.
getSetupFeeAccountingCode()  : string|null
Getter method for the setup_fee_accounting_code attribute.
getSetupFeeRevenueScheduleType()  : string|null
Getter method for the setup_fee_revenue_schedule_type attribute.
getState()  : string|null
Getter method for the state attribute.
getTaxCode()  : string|null
Getter method for the tax_code attribute.
getTaxExempt()  : bool|null
Getter method for the tax_exempt attribute.
getTotalBillingCycles()  : int|null
Getter method for the total_billing_cycles attribute.
getTrialLength()  : int|null
Getter method for the trial_length attribute.
getTrialRequiresBillingInfo()  : bool|null
Getter method for the trial_requires_billing_info attribute.
getTrialUnit()  : string|null
Getter method for the trial_unit attribute.
getUpdatedAt()  : string|null
Getter method for the updated_at attribute.
getVertexTransactionType()  : string|null
Getter method for the vertex_transaction_type attribute.
setAccountingCode()  : void
Setter method for the accounting_code attribute.
setAllowAnyItemOnSubscriptions()  : void
Setter method for the allow_any_item_on_subscriptions attribute.
setAutoRenew()  : void
Setter method for the auto_renew attribute.
setAvalaraServiceType()  : void
Setter method for the avalara_service_type attribute.
setAvalaraTransactionType()  : void
Setter method for the avalara_transaction_type attribute.
setCode()  : void
Setter method for the code attribute.
setCreatedAt()  : void
Setter method for the created_at attribute.
setCurrencies()  : void
Setter method for the currencies attribute.
setCustomFields()  : void
Setter method for the custom_fields attribute.
setDeletedAt()  : void
Setter method for the deleted_at attribute.
setDescription()  : void
Setter method for the description attribute.
setDunningCampaignId()  : void
Setter method for the dunning_campaign_id attribute.
setHostedPages()  : void
Setter method for the hosted_pages attribute.
setId()  : void
Setter method for the id attribute.
setIntervalLength()  : void
Setter method for the interval_length attribute.
setIntervalUnit()  : void
Setter method for the interval_unit attribute.
setName()  : void
Setter method for the name attribute.
setObject()  : void
Setter method for the object attribute.
setPricingModel()  : void
Setter method for the pricing_model attribute.
setRampIntervals()  : void
Setter method for the ramp_intervals attribute.
setRevenueScheduleType()  : void
Setter method for the revenue_schedule_type attribute.
setSetupFeeAccountingCode()  : void
Setter method for the setup_fee_accounting_code attribute.
setSetupFeeRevenueScheduleType()  : void
Setter method for the setup_fee_revenue_schedule_type attribute.
setState()  : void
Setter method for the state attribute.
setTaxCode()  : void
Setter method for the tax_code attribute.
setTaxExempt()  : void
Setter method for the tax_exempt attribute.
setTotalBillingCycles()  : void
Setter method for the total_billing_cycles attribute.
setTrialLength()  : void
Setter method for the trial_length attribute.
setTrialRequiresBillingInfo()  : void
Setter method for the trial_requires_billing_info attribute.
setTrialUnit()  : void
Setter method for the trial_unit attribute.
setUpdatedAt()  : void
Setter method for the updated_at attribute.
setVertexTransactionType()  : void
Setter method for the vertex_transaction_type 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 = ['setCurrencies' => '\Recurly\Resources\PlanPricing', 'setCustomFields' => '\Recurly\Resources\CustomField', 'setRampIntervals' => '\Recurly\Resources\PlanRampInterval']

$_accounting_code

private mixed $_accounting_code

$_allow_any_item_on_subscriptions

private mixed $_allow_any_item_on_subscriptions

$_auto_renew

private mixed $_auto_renew

$_avalara_service_type

private mixed $_avalara_service_type

$_avalara_transaction_type

private mixed $_avalara_transaction_type

$_code

private mixed $_code

$_created_at

private mixed $_created_at

$_currencies

private mixed $_currencies

$_custom_fields

private mixed $_custom_fields

$_deleted_at

private mixed $_deleted_at

$_description

private mixed $_description

$_dunning_campaign_id

private mixed $_dunning_campaign_id

$_hosted_pages

private mixed $_hosted_pages

$_interval_length

private mixed $_interval_length

$_interval_unit

private mixed $_interval_unit

$_name

private mixed $_name

$_object

private mixed $_object

$_pricing_model

private mixed $_pricing_model

$_ramp_intervals

private mixed $_ramp_intervals

$_revenue_schedule_type

private mixed $_revenue_schedule_type

$_setup_fee_accounting_code

private mixed $_setup_fee_accounting_code

$_setup_fee_revenue_schedule_type

private mixed $_setup_fee_revenue_schedule_type

$_state

private mixed $_state

$_tax_code

private mixed $_tax_code

$_tax_exempt

private mixed $_tax_exempt

$_total_billing_cycles

private mixed $_total_billing_cycles

$_trial_length

private mixed $_trial_length

$_trial_requires_billing_info

private mixed $_trial_requires_billing_info

$_trial_unit

private mixed $_trial_unit

$_updated_at

private mixed $_updated_at

$_vertex_transaction_type

private mixed $_vertex_transaction_type

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

getAccountingCode()

Getter method for the accounting_code attribute.

public getAccountingCode() : string|null

Accounting code for invoice line items for the plan. If no value is provided, it defaults to plan's code.

Return values
string|null —

getAllowAnyItemOnSubscriptions()

Getter method for the allow_any_item_on_subscriptions attribute.

public getAllowAnyItemOnSubscriptions() : bool|null

Used to determine whether items can be assigned as add-ons to individual subscriptions. If true, items can be assigned as add-ons to individual subscription add-ons. If false, only plan add-ons can be used.

Return values
bool|null —

getAutoRenew()

Getter method for the auto_renew attribute.

public getAutoRenew() : bool|null

Subscriptions will automatically inherit this value once they are active. If auto_renew is true, then a subscription will automatically renew its term at renewal. If auto_renew is false, then a subscription will expire at the end of its term. auto_renew can be overridden on the subscription record itself.

Return values
bool|null —

getAvalaraServiceType()

Getter method for the avalara_service_type attribute.

public getAvalaraServiceType() : int|null

Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the plan is taxed. Refer to the documentation for more available t/s types.

Return values
int|null —

getAvalaraTransactionType()

Getter method for the avalara_transaction_type attribute.

public getAvalaraTransactionType() : int|null

Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the plan is taxed. Refer to the documentation for more available t/s types.

Return values
int|null —

getCode()

Getter method for the code attribute.

public getCode() : string|null

Unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.

Return values
string|null —

getCreatedAt()

Getter method for the created_at attribute.

public getCreatedAt() : string|null

Created at

Return values
string|null —

getCurrencies()

Getter method for the currencies attribute.

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

Pricing

Return values
array<string|int, mixed> —

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 —

getDescription()

Getter method for the description attribute.

public getDescription() : string|null

Optional description, not displayed.

Return values
string|null —

getDunningCampaignId()

Getter method for the dunning_campaign_id attribute.

public getDunningCampaignId() : string|null

Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.

Return values
string|null —

getId()

Getter method for the id attribute.

public getId() : string|null

Plan ID

Return values
string|null —

getIntervalLength()

Getter method for the interval_length attribute.

public getIntervalLength() : int|null

Length of the plan's billing interval in interval_unit.

Return values
int|null —

getIntervalUnit()

Getter method for the interval_unit attribute.

public getIntervalUnit() : string|null

Unit for the plan's billing interval.

Return values
string|null —

getName()

Getter method for the name attribute.

public getName() : string|null

This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.

Return values
string|null —

getObject()

Getter method for the object attribute.

public getObject() : string|null

Object type

Return values
string|null —

getPricingModel()

Getter method for the pricing_model attribute.

public getPricingModel() : string|null

A fixed pricing model has the same price for each billing period. A ramp pricing model defines a set of Ramp Intervals, where a subscription changes price on a specified cadence of billing periods. The price change could be an increase or decrease.

Return values
string|null —

getRampIntervals()

Getter method for the ramp_intervals attribute.

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

Ramp Intervals

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 —

getSetupFeeAccountingCode()

Getter method for the setup_fee_accounting_code attribute.

public getSetupFeeAccountingCode() : string|null

Accounting code for invoice line items for the plan's setup fee. If no value is provided, it defaults to plan's accounting code.

Return values
string|null —

getSetupFeeRevenueScheduleType()

Getter method for the setup_fee_revenue_schedule_type attribute.

public getSetupFeeRevenueScheduleType() : string|null

Setup fee revenue schedule type

Return values
string|null —

getState()

Getter method for the state attribute.

public getState() : string|null

The current state of the plan.

Return values
string|null —

getTaxCode()

Getter method for the tax_code attribute.

public getTaxCode() : string|null

Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of unknown, physical, or digital tax codes.

Return values
string|null —

getTaxExempt()

Getter method for the tax_exempt attribute.

public getTaxExempt() : bool|null

true exempts tax on the plan, false applies tax on the plan.

Return values
bool|null —

getTotalBillingCycles()

Getter method for the total_billing_cycles attribute.

public getTotalBillingCycles() : int|null

Automatically terminate subscriptions after a defined number of billing cycles. Number of billing cycles before the plan automatically stops renewing, defaults to null for continuous, automatic renewal.

Return values
int|null —

getTrialLength()

Getter method for the trial_length attribute.

public getTrialLength() : int|null

Length of plan's trial period in trial_units. 0 means no trial.

Return values
int|null —

getTrialRequiresBillingInfo()

Getter method for the trial_requires_billing_info attribute.

public getTrialRequiresBillingInfo() : bool|null

Allow free trial subscriptions to be created without billing info. Should not be used if billing info is needed for initial invoice due to existing uninvoiced charges or setup fee.

Return values
bool|null —

getTrialUnit()

Getter method for the trial_unit attribute.

public getTrialUnit() : string|null

Units for the plan's trial period.

Return values
string|null —

getUpdatedAt()

Getter method for the updated_at attribute.

public getUpdatedAt() : string|null

Last updated at

Return values
string|null —

getVertexTransactionType()

Getter method for the vertex_transaction_type attribute.

public getVertexTransactionType() : string|null

Used by Vertex for tax calculations. Possible values are sale, rental, lease.

Return values
string|null —

setAccountingCode()

Setter method for the accounting_code attribute.

public setAccountingCode(string $accounting_code) : void
Parameters
$accounting_code : string
Return values
void —

setAllowAnyItemOnSubscriptions()

Setter method for the allow_any_item_on_subscriptions attribute.

public setAllowAnyItemOnSubscriptions(bool $allow_any_item_on_subscriptions) : void
Parameters
$allow_any_item_on_subscriptions : bool
Return values
void —

setAutoRenew()

Setter method for the auto_renew attribute.

public setAutoRenew(bool $auto_renew) : void
Parameters
$auto_renew : bool
Return values
void —

setAvalaraServiceType()

Setter method for the avalara_service_type attribute.

public setAvalaraServiceType(int $avalara_service_type) : void
Parameters
$avalara_service_type : int
Return values
void —

setAvalaraTransactionType()

Setter method for the avalara_transaction_type attribute.

public setAvalaraTransactionType(int $avalara_transaction_type) : void
Parameters
$avalara_transaction_type : int
Return values
void —

setCode()

Setter method for the code attribute.

public setCode(string $code) : void
Parameters
$code : 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 —

setCurrencies()

Setter method for the currencies attribute.

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

setDescription()

Setter method for the description attribute.

public setDescription(string $description) : void
Parameters
$description : 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 —

setHostedPages()

Setter method for the hosted_pages attribute.

public setHostedPages(PlanHostedPages $hosted_pages) : void
Parameters
$hosted_pages : PlanHostedPages
Return values
void —

setId()

Setter method for the id attribute.

public setId(string $id) : void
Parameters
$id : string
Return values
void —

setIntervalLength()

Setter method for the interval_length attribute.

public setIntervalLength(int $interval_length) : void
Parameters
$interval_length : int
Return values
void —

setIntervalUnit()

Setter method for the interval_unit attribute.

public setIntervalUnit(string $interval_unit) : void
Parameters
$interval_unit : string
Return values
void —

setName()

Setter method for the name attribute.

public setName(string $name) : void
Parameters
$name : string
Return values
void —

setObject()

Setter method for the object attribute.

public setObject(string $object) : void
Parameters
$object : string
Return values
void —

setPricingModel()

Setter method for the pricing_model attribute.

public setPricingModel(string $pricing_model) : void
Parameters
$pricing_model : string
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 —

setSetupFeeAccountingCode()

Setter method for the setup_fee_accounting_code attribute.

public setSetupFeeAccountingCode(string $setup_fee_accounting_code) : void
Parameters
$setup_fee_accounting_code : string
Return values
void —

setSetupFeeRevenueScheduleType()

Setter method for the setup_fee_revenue_schedule_type attribute.

public setSetupFeeRevenueScheduleType(string $setup_fee_revenue_schedule_type) : void
Parameters
$setup_fee_revenue_schedule_type : string
Return values
void —

setState()

Setter method for the state attribute.

public setState(string $state) : void
Parameters
$state : string
Return values
void —

setTaxCode()

Setter method for the tax_code attribute.

public setTaxCode(string $tax_code) : void
Parameters
$tax_code : string
Return values
void —

setTaxExempt()

Setter method for the tax_exempt attribute.

public setTaxExempt(bool $tax_exempt) : void
Parameters
$tax_exempt : bool
Return values
void —

setTotalBillingCycles()

Setter method for the total_billing_cycles attribute.

public setTotalBillingCycles(int $total_billing_cycles) : void
Parameters
$total_billing_cycles : int
Return values
void —

setTrialLength()

Setter method for the trial_length attribute.

public setTrialLength(int $trial_length) : void
Parameters
$trial_length : int
Return values
void —

setTrialRequiresBillingInfo()

Setter method for the trial_requires_billing_info attribute.

public setTrialRequiresBillingInfo(bool $trial_requires_billing_info) : void
Parameters
$trial_requires_billing_info : bool
Return values
void —

setTrialUnit()

Setter method for the trial_unit attribute.

public setTrialUnit(string $trial_unit) : void
Parameters
$trial_unit : 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 —

setVertexTransactionType()

Setter method for the vertex_transaction_type attribute.

public setVertexTransactionType(string $vertex_transaction_type) : void
Parameters
$vertex_transaction_type : 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