NAME

Net::Simplify::Customer - A Simplify Commerce Customer object

SYNOPSIS

use Net::Simplify;


$Net::Simplify::public_key = 'YOUR PUBLIC KEY';
$Net::Simplify::private_key = 'YOUR PRIVATE KEY';

# Create a new Customer.
my $customer = Net::Simplify::Customer->create{ {...});

# Retrieve a Customer given its ID.
my $customer = Net::Simplify::Customer->find('a7e41');

# Update existing Customer.
my $customer = Net::Simplify::Customer->find('a7e41');
$customer->{PROPERTY} = "NEW VALUE";
$customer->update();

# Delete
my $customer = Net::Simplify::Customer->find('a7e41');
$customer->delete();

# Retrieve a list of objects
my $customers = Net::Simplify::Customer->list({max => 10});
foreach my $v ($customers->list) {
    # ...
}

DESCRIPTION

METHODS

create(%params, $auth)

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

%params

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

card.addressCity: City of the cardholder. (required)
card.addressCountry: Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. (required)
card.addressLine1: Address of the cardholder (required)
card.addressLine2: Address of the cardholder if needed. (required)
card.addressState: State of residence of the cardholder. State abbreviations should be used. (required)
card.addressZip: Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters. (required)
card.cvc: CVC security code of the card. This is the code on the back of the card. Example: 123 (required)
card.expMonth: Expiration month of the card. Format is MM. Example: January = 01 (required)
card.expYear: Expiration year of the card. Format is YY. Example: 2013 = 13 (required)
card.id: ID of card. Unused during customer create.
card.name: Name as appears on the card. (required)
card.number: Card number as it appears on the card. [max length: 19, min length: 13]
email: Email address of the customer (required)
name: Customer name [max length: 50, min length: 2] (required)
reference: Reference field for external applications use.
subscriptions.amount: Amount of payment in the smallest unit of your currency. Example: 100 = $1.00
subscriptions.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]
subscriptions.billingCycleLimit: The number of fixed billing cycles for a plan. Only used if the billingCycle parameter is set to FIXED. Example: 4
subscriptions.coupon: Coupon associated with the subscription for the customer.
subscriptions.currency: Currency code (ISO-4217). Must match the currency associated with your account.
subscriptions.currentPeriodEnd: End date of subscription's current period
subscriptions.currentPeriodStart: Start date of subscription's current period
subscriptions.customer: The customer ID to create the subscription for. Do not supply this when creating a customer.
subscriptions.frequency: Frequency of payment for the plan. Used in conjunction with frequencyPeriod. Valid values are "DAILY", "WEEKLY", "MONTHLY" and "YEARLY".
subscriptions.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.
subscriptions.name: Name describing subscription [max length: 50]
subscriptions.plan: The plan ID that the subscription should be created from.
subscriptions.quantity: Quantity of the plan for the subscription. [min value: 1]
subscriptions.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.
subscriptions.source: Source of where subscription was created
token: If specified, card associated with card token will be used

$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::Customer object. Authentication is done using the same credentials used when the AccessToken was created.

list(%criteria, $auth)

Retrieve a list of Net::Simplify::Customer 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.id</td><td>Filter by the customer Id</td></tr><tr><td>filter.text</td><td>Can use this to filter by the name, email or reference for the customer</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></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
name
email
reference

find($id, $auth)

Retrieve a Net::Simplify::Customer 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::Customer object. The properties that can be updated are:

card.addressCity

City of the cardholder. (required)

card.addressCountry

Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. (required)

card.addressLine1

Address of the cardholder. (required)

card.addressLine2

Address of the cardholder if needed. (required)

card.addressState

State of residence of the cardholder. State abbreviations should be used. (required)

card.addressZip

Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters. (required)

card.cvc

CVC security code of the card. This is the code on the back of the card. Example: 123 (required)

card.expMonth

Expiration month of the card. Format is MM. Example: January = 01 (required)

card.expYear

Expiration year of the card. Format is YY. Example: 2013 = 13 (required)

card.id

ID of card. If present, card details for the customer will not be updated. If not present, the customer will be updated with the supplied card details.

card.name

Name as appears on the card. (required)

card.number

Card number as it appears on the card. [max length: 19, min length: 13]

email

Email address of the customer (required)

name

Customer name [max length: 50, min length: 2] (required)

reference

Reference field for external applications use.

token

If specified, card associated with card token will be added to the customer

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

VERSION

1.6.0

LICENSE

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.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

SYNOPSIS

DESCRIPTION

METHODS

create(%params, $auth)

delete()

list(%criteria, $auth)

find($id, $auth)

update()

SEE ALSO

VERSION

LICENSE

SEE ALSO

NAME

SYNOPSIS

DESCRIPTION

METHODS

create(%params, $auth)

delete()

list(%criteria, $auth)

find($id, $auth)

update()

SEE ALSO

VERSION

LICENSE

SEE ALSO

Module Install Instructions