Recurly_Coupon::redeemCoupon PHP Method

redeemCoupon() public method

public redeemCoupon ( $accountCode, $currency, $subscriptionUUID = null )
    public function redeemCoupon($accountCode, $currency, $subscriptionUUID = null)
    {
        if ($this->state != 'redeemable') {
            throw new Recurly_Error('Coupon is not redeemable.');
        }
        $redemption = new Recurly_CouponRedemption(null, $this->_client);
        $redemption->account_code = $accountCode;
        $redemption->currency = $currency;
        $redemption->subscription_uuid = $subscriptionUUID;
        foreach ($this->_links as $link) {
            if ($link->name == 'redeem') {
                $redemption->_save(strtoupper($link->method), $link->href);
                return $redemption;
            }
        }
    }