/ 
Net-Simplify-1.6.0
River stage zero No dependents
/ Net::Simplify::Subscription

NAME

Net::Simplify::Subscription - A Simplify Commerce Subscription object

SYNOPSIS

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 $v ($subscriptions->list) {
    # ...
}

DESCRIPTION

METHODS

create(%params, $auth)

Creates a Net::Simplify::Subscription object. The parameters are:

%params

Hash map containing initial values for the object. Valid keys are:

amount

Amount of the payment in the smallest unit of your currency. Example: 100 = $1.00

billingCycle

How the plan is billed to the customer. Values must be AUTO (indefinitely until the customer cancels) or FIXED (a fixed number of billing cycles). [default: AUTO]

billingCycleLimit

The number of fixed billing cycles for a plan. Only used if the billingCycle parameter is set to FIXED. Example: 4

coupon

Coupon ID associated with the subscription

currency

Currency code (ISO-4217). Must match the currency associated with your account.

currentPeriodEnd

End date of subscription's current period

currentPeriodStart

Start date of subscription's current period

customer

Customer that is enrolling in the subscription.

frequency

Frequency of payment for the plan. Used in conjunction with frequencyPeriod. Valid values are "DAILY", "WEEKLY", "MONTHLY" and "YEARLY".

frequencyPeriod

Period of frequency of payment for the plan. Example: if the frequency is weekly, and periodFrequency is 2, then the subscription is billed bi-weekly.

name

Name describing subscription [max length: 50]

plan

The ID of the plan that should be used for the subscription.

quantity

Quantity of the plan for the subscription. [min value: 1]

renewalReminderLeadDays

If set, how many days before the next billing cycle that a renewal reminder is sent to the customer. If null, then no emails are sent. Minimum value is 7 if set.

source

Source of where subscription was created

$auth

Authentication object for accessing the API. If no value is passed the global keys $Net::Simplify::public_key and $Net::Simplify::private_key are used.

delete()

Deletes the Net::Simplify::Subscription object. Authentication is done using the same credentials used when the AccessToken was created.

list(%criteria, $auth)

Retrieve a list of Net::Simplify::Subscription objects. The parameters are:

%criteria

Hash map representing the criteria to limit the results of the list operation. Valid keys are:

filter

<table class="filter_list"><tr><td>filter.customer</td><td>Filter by the Id of the customer with the subscription</td></tr><tr><td>filter.plan</td><td>Filter by the Id of the plan linked to the subscription</td></tr><tr><td>filter.dateCreatedMin<sup>*</sup></td><td>Filter by the minimum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.dateCreatedMax<sup>*</sup></td><td>Filter by the maximum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.q</td><td>You can use this to filter by the Id, the name or the amount of the subscription</td></tr></table><br><sup>*</sup>Use dateCreatedMin with dateCreatedMax in the same filter if you want to search between two created dates

max

Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]

offset

Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]

sorting

Allows 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:

dateCreated
id
plan

find($id, $auth)

Retrieve a Net::Simplify::Subscription object from the API. Parameters are:

$id

Identifier of the object to retrieve.

$auth

Authentication 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()

Update Net::Simplify::Subscription object. The properties that can be updated are:

amount

Amount of the payment in the smallest unit of your currency. Example: 100 = $1.00

billingCycle

How the plan is billed to the customer. Values must be AUTO (indefinitely until the customer cancels) or FIXED (a fixed number of billing cycles). [default: AUTO]

billingCycleLimit

The number of fixed billing cycles for a plan. Only used if the billingCycle parameter is set to FIXED. Example: 4

coupon

Coupon being assigned to this subscription

currency

Currency code (ISO-4217). Must match the currency associated with your account.

currentPeriodEnd

End date of subscription's current period

currentPeriodStart

Start date of subscription's current period

frequency

Frequency of payment for the plan. Used in conjunction with frequencyPeriod. Valid values are "DAILY", "WEEKLY", "MONTHLY" and "YEARLY".

frequencyPeriod

Period of frequency of payment for the plan. Example: if the frequency is weekly, and periodFrequency is 2, then the subscription is billed bi-weekly. [min value: 1]

name

Name describing subscription

plan

Plan that should be used for the subscription.

prorate

Whether to prorate existing subscription. [default: true] (required)

quantity

Quantity of the plan for the subscription. [min value: 1]

renewalReminderLeadDays

If set, how many days before the next billing cycle that a renewal reminder is sent to the customer. If null or 0, no emails are sent. Minimum value is 7 if set.

Authentication is done using the same credentials used when the AccessToken was created.

SEE ALSO

Net::Simplify, Net::Simplify::Domain, Net::Simplify::DomainList, Net::Simplify::Authentication, Net::Simplify::ApiException, http://www.simplify.com

VERSION

1.6.0

LICENSE

Copyright (c) 2013 - 2022 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.

SEE ALSO