Net::Simplify::Coupon

<<

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

# NAME

Net::Simplify::Coupon - A Simplify Commerce Coupon object

# SYNOPSIS

      use Net::Simplify;

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

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

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

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

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

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

# DESCRIPTION

## METHODS

### create(%params, $auth)

Creates a `Net::Simplify::Coupon` object. The parameters are:

`%params`

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

  amountOff

    Amount off of the price of the product in the smallest units of the currency of the merchant. While this field is optional, you must provide either amountOff or percentOff for a coupon. Example: 100 = $1.00USD [min value: 1, max value: 9999900]

  couponCode

    Code that identifies the coupon to be used. [min length: 2] (required)

  description

    A brief section that describes the coupon.

  durationInMonths

    Duration in months that the coupon will be applied after it has first been selected. [min value: 1, max value: 9999]

  endDate

    Last date of the coupon in UTC millis that the coupon can be applied to a subscription. This ends at 23:59:59 of the merchant timezone.

  maxRedemptions

    Maximum number of redemptions allowed for the coupon. A redemption is defined as when the coupon is applied to the subscription for the first time. [min value: 1]

  percentOff

    Percentage off of the price of the product. While this field is optional, you must provide either amountOff or percentOff for a coupon. The percent off is a whole number. [min value: 1, max value: 100]

  startDate

    First date of the coupon in UTC millis that the coupon can be applied to a subscription. This starts at midnight of the merchant timezone. (required)

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

### list(%criteria, $auth)

Retrieve a list of `Net::Simplify::Coupon` 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`
    `maxRedemptions`
    `timesRedeemed`
    `id`
    `startDate`
    `endDate`
    `percentOff`
    `couponCode`
    `durationInMonths`
    `amountOff`

### find($id, $auth)

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

`endDate`

  The ending date in UTC millis for the coupon. This must be after the starting date of the coupon.

`maxRedemptions`

  Maximum number of redemptions allowed for the coupon. A redemption is defined as when the coupon is applied to the subscription for the first time. [min value: 1]

  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

<<