PHP Class Recurly_Subscription, recurly-client-php

Inheritance: extends Recurly_Resource

显示文件 Open project: recurly/recurly-client-php Class Usage Examples

Public Methods

Method	Description
__construct ( $href = null, $client = null )
buildUsage ( $addOnCode, $client = null )
cancel ( )	Cancel the subscription; it will remain active until it renews.
create ( )
get ( $uuid, $client = null )
postpone ( $nextRenewalDate, $bulk = false )	Postpone a subscription's renewal date.
preview ( )	Preview the creation and check for errors.
reactivate ( )	Reactivate a canceled subscription. The subscription will return back to the active, auto renewing state.
terminateAndPartialRefund ( )	Terminate the subscription immediately and issue a prorated/partial refund of the last renewal
terminateAndRefund ( )	Terminate the subscription immediately and issue a full refund of the last renewal
terminateWithoutRefund ( )	Terminate the subscription immediately without a refund
updateAtRenewal ( )	Make an update that applies when the subscription renews.
updateImmediately ( )	Make an update that takes effect immediately.
updateNotes ( $notes )	Updates the notes fields of the subscription without generating a SubscriptionChange.
usages ( $addOnCode, $params = null )

Protected Methods

Method	Description
getNodeName ( )
getWriteableAttributes ( )
uri ( )
uriForSubscription ( $uuid )

Private Methods

Method	Description
terminate ( $refundType )

Method Details

__construct() public method

public __construct ( $href = null, $client = null )

buildUsage() public method

public buildUsage ( $addOnCode, $client = null )

cancel() public method

Cancel the subscription; it will remain active until it renews.

public cancel ( )

create() public method

public create ( )

get() public static method

public static get ( $uuid, $client = null )

getNodeName() protected method

protected getNodeName ( )

getWriteableAttributes() protected method

protected getWriteableAttributes ( )

postpone() public method

Postpone a subscription's renewal date.

public postpone ( $nextRenewalDate, $bulk = false )

preview() public method

Note: once preview() has been called you will not be able to call create() or save() without reassiging all the attributes.

public preview ( )

reactivate() public method

Reactivate a canceled subscription. The subscription will return back to the active, auto renewing state.

public reactivate ( )

terminateAndPartialRefund() public method

Terminate the subscription immediately and issue a prorated/partial refund of the last renewal

public terminateAndPartialRefund ( )

terminateAndRefund() public method

Terminate the subscription immediately and issue a full refund of the last renewal

public terminateAndRefund ( )

terminateWithoutRefund() public method

Terminate the subscription immediately without a refund

public terminateWithoutRefund ( )

updateAtRenewal() public method

Make an update that applies when the subscription renews.

public updateAtRenewal ( )

updateImmediately() public method

Make an update that takes effect immediately.

public updateImmediately ( )

updateNotes() public method

Updates the notes fields of the subscription without generating a SubscriptionChange.

public updateNotes ( $notes )

uri() protected method

protected uri ( )

uriForSubscription() protected static method

protected static uriForSubscription ( $uuid )

usages() public method

public usages ( $addOnCode, $params = null )