Net::Simplify::Customer

<<

- NAME
- SYNOPSIS
- DESCRIPTION
  - METHODS
    - create(%params, $auth)
    - delete()
    - list(%criteria, $auth)
    - find($id, $auth)
    - update()
- SEE ALSO
- VERSION
- LICENSE
- SEE ALSO

# 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 code (USPS code) of residence of the cardholder. (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 [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.00USD [min value: 50, max value: 9999900]

  subscriptions.coupon

    Coupon associated with the subscription for the customer.

  subscriptions.currency

    Currency code (ISO-4217). Must match the currency associated with your account. [default: USD]

  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. Example: Monthly

  subscriptions.name

    Name describing subscription

  subscriptions.plan

    The plan ID that the subscription should be created from.

  subscriptions.quantity

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

  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`

    Filters to apply to the list.

  `max`

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

  `offset`

    Used in paging of the list. This is the start offset of the page. [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 code (USPS code) of residence of the cardholder. (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 [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.

# SEE ALSO

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

# VERSION

1.1.0

# LICENSE

Copyright (c) 2013, 2014 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

<<