Package simplify :: Class Plan
[hide private]
[frames] | no frames]

Class Plan

source code

domain.Domain --+
                |
               Plan

A Plan object.

Instance Methods [hide private]
 
delete(self, *auth_args)
Delete this object
source code
 
update(self, *auth_args)
Updates this object
source code

Inherited from domain.Domain: __getitem__, __init__, __str__, class_name, to_dict

Static Methods [hide private]
 
create(params, *auth_args)
Creates an Plan object
source code
 
list(criteria=None, *auth_args)
Retrieve Plan objects.
source code
 
find(object_id, *auth_args)
Retrieve a Plan object from the API
source code
Method Details [hide private]

create(params, *auth_args)
Static Method

source code 

Creates an Plan object

Parameters:
  • params - a dict of parameters; valid keys are:
    • amount: Amount of payment for the plan in minor units. Example: 1000 = 10.00 [min value: 50, max value: 99999999] required
    • currency: Currency code (ISO-4217) for the plan. Must match the currency associated with your account. [default: USD] required
    • frequency: Frequency of payment for the plan. Example: Monthly required
    • name: Name of the plan [max length: 50, min length: 2] required
  • auth_args - an Authentication object used for the API call. If no value is passed the gloabl keys simplify.public_key and simplify.private_key are used. For backwards compatibility the public and private keys may be passed instead of an Authentication object.
  • private_api_key - Private key to use for the API call. If None, the value of simplify.private_key will be used.
Returns:
a Plan object

delete(self, *auth_args)

source code 

Delete this object

Parameters:
  • auth_args - an Authentication object used for the API call. If no value is passed the gloabl keys simplify.public_key and simplify.private_key are used. For backwards compatibility the public and private keys may be passed instead of an Authentication object.

list(criteria=None, *auth_args)
Static Method

source code 

Retrieve Plan objects.

Parameters:
  • criteria - a dict of parameters; 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 amount frequency name id.
  • auth_args - an Authentication object used for the API call. If no value is passed the gloabl keys simplify.public_key and simplify.private_key are used. For backwards compatibility the public and private keys may be passed instead of an Authentication object.
Returns:
an object which contains the list of Plan objects in the <code>list</code> property and the total number of objects available for the given criteria in the <code>total</code> property.

find(object_id, *auth_args)
Static Method

source code 

Retrieve a Plan object from the API

Parameters:
  • object_id - ID of object to retrieve
  • auth_args - an Authentication object used for the API call. If no value is passed the gloabl keys simplify.public_key and simplify.private_key are used. For backwards compatibility the public and private keys may be passed instead of an Authentication object.
Returns:
a Plan object

update(self, *auth_args)

source code 

Updates this object

The properties that can be updated:

  • name Name of the plan. [min length: 2] (required)
Parameters:
  • auth_args - an Authentication object used for the API call. If no value is passed the gloabl keys simplify.public_key and simplify.private_key are used. For backwards compatibility the public and private keys may be passed instead of an Authentication object.
Returns:
a Plan object.