Net::Simplify::Subscription - A Simplify Commerce Subscription object
use Net::Simplify;
$Net::Simplify::public_key = 'YOUR PUBLIC KEY';
$Net::Simplify::private_key = 'YOUR PRIVATE KEY';
# Create a new Subscription.
my $subscription = Net::Simplify::Subscription->create{ {...});
# Retrieve a Subscription given its ID.
my $subscription = Net::Simplify::Subscription->find('a7e41');
# Update existing Subscription.
my $subscription = Net::Simplify::Subscription->find('a7e41');
$subscription->{PROPERTY} = "NEW VALUE";
$subscription->update();
# Delete
my $subscription = Net::Simplify::Subscription->find('a7e41');
$subscription->delete();
# Retrieve a list of objects
my $subscriptions = Net::Simplify::Subscription->list({max => 10});
foreach my $$subscription ($subscriptions->list) {
# ...
}
Creates a Net::Simplify::Subscription object. The parameters are:
%paramsHash map containing initial values for the object. Valid keys are:
Amount of the payment (minor units). Example: 1000 = 10.00
Coupon ID associated with the subscription
Currency code (ISO-4217). Must match the currency associated with your account. (default:USD)
Customer that is enrolling in the subscription.
Frequency of payment for the plan. Example: Monthly
Name describing subscription
The ID of the plan that should be used for the subscription.
Quantity of the plan for the subscription.
$authAuthentication object for accessing the API. If no value is passed the global keys $Net::Simplify::public_key and $Net::Simplify::private_key are used.
Deletes the Net::Simplify::Subscription object. Authentication is done using the same credentials used when the AccessToken was created.
Retrieve a list of Net::Simplify::Subscription objects. The parameters are:
%criteriaHash map representing the criteria to limit the results of the list operation. Valid keys are:
filterFilters to apply to the list.
maxAllows up to a max of 50 list items to return.
(default: 20)
offsetUsed in paging of the list. This is the start offset of the page.
(default: 0)
sortingAllows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are:
idplanRetrieve a Net::Simplify::Subscription object from the API. Parameters are:
$idIdentifier of the object to retrieve.
$authAuthentication object for accessing the API. If no value is passed the global keys $Net::Simplify::public_key and $Net::Simplify::private_key are used.
Update Net::Simplify::Subscription object. The properties that can be updated are:
amountcouponcurrencyfrequencynameplanprorate(required)
quantityAuthentication is done using the same credentials used when the AccessToken was created.
Net::Simplify, Net::Simplify::Domain, Net::Simplify::DomainList, Net::Simplify::Authentication, Net::Simplify::ApiException, http://www.simplify.com
1.0.2
Copyright (c) 2013, MasterCard International Incorporated All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the MasterCard International Incorporated nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.