Simplify::Plan

Authentication object used to access the API (See Simplify::Authentication for details)

Creates an Plan object

• amount Amount of payment for the plan in the smallest unit of your currency. Example: 100 = $1.00 required

• 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

• 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. Used in conjunction with frequencyPeriod. Valid values are "DAILY", "WEEKLY", "MONTHLY" and "YEARLY". [default: MONTHLY] required

• 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, default: 1] required

• name Name of the plan [max length: 50, min length: 2] required

• 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.

• trialPeriod Plan free trial period selection. Must be Days, Weeks, or Month [default: NONE] required

• trialPeriodQuantity Quantity of the trial period. Must be greater than 0 and a whole number. [min value: 1]

Returns a Plan object.

# File lib/simplify/plan.rb, line 75
def self.create(parms, *auth)

    auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
    h = Simplify::PaymentsApi.execute("plan", 'create', parms, auth_obj)
    obj = Plan.new()
    obj.authentication = auth_obj
    obj = obj.merge!(h)
    obj
end

Retrieve a Plan object from the API

Returns a Plan object.

# File lib/simplify/plan.rb, line 117
def self.find(id, *auth)

    auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
    h = Simplify::PaymentsApi.execute("plan", 'show', {"id" => id}, auth_obj)
    obj = Plan.new()
    obj.authentication = auth_obj
    obj = obj.merge!(h)
    obj
end

Retrieve Plan objects.

• filter <table class="filter_list"><tr><td>filter.id</td><td>Filter by the plan Id</td></tr><tr><td>filter.text</td><td>Filter by the name of the plan</td></tr><tr><td>filter.frequency</td><td>Filter by the frequency of the plan</td></tr><tr><td>filter.amountMin & filter.amountMax</td><td>The filter amountMin must be used with amountMax to find plans with plan values between the min and max figures</td></tr><tr><td>filter.dateCreatedMin^*</td><td>Filter by the minimum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.dateCreatedMax^*</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 plan</td></tr></table><br>^*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 amount frequency name id.

Returns an object where the list property contains the list of Plan objects and the total property contains the total number of Plan objects available for the given criteria.

# File lib/simplify/plan.rb, line 101
def self.list(criteria = nil, *auth)

    auth_obj = Simplify::PaymentsApi.create_auth_object(auth)
    h = Simplify::PaymentsApi.execute("plan", 'list', criteria, auth_obj)
    obj = Plan.new()
    obj.authentication = auth_obj
    obj = obj.merge!(h)
    obj

end

Delete this object

# File lib/simplify/plan.rb, line 86
def delete()
    h = Simplify::PaymentsApi.execute("plan", 'delete', self, self.authentication)
    self.merge!(h)
    self
end

Returns the private key used when accessing this object. Deprecated: please use ‘authentication’ instead.

# File lib/simplify/plan.rb, line 50
def private_key
    return self.authentication.private_key
end

Sets the private key used when accessing this object. Deprecated: please use ‘authentication’ instead.

# File lib/simplify/plan.rb, line 55
def private_key=(k)
    return self.authentication.private_key = k
end

Returns the public key used when accessing this object. Deprecated: please use ‘authentication’ instead.

# File lib/simplify/plan.rb, line 40
def public_key
    return self.authentication.public_key
end

Sets the public key used when accessing this object. Deprecated: please use ‘authentication’ instead.

# File lib/simplify/plan.rb, line 45
def public_key=(k)
    return self.authentication.public_key = k
end

Updates this object

The properties that can be updated:

• name Name of the plan. [min length: 2] (required)

# File lib/simplify/plan.rb, line 131
def update()
      h = Simplify::PaymentsApi.execute("plan", 'update', self, self.authentication)
      self.merge!(h)
      self
end