Class: ProcessOut::Subscription

Inherits:
Object
  • Object
show all
Defined in:
lib/processout/subscription.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Subscription

Initializes the Subscription object Params:

client

ProcessOut client instance



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/processout/subscription.rb', line 164

def initialize(client)
  @client = client

  @id = ""
  @project = nil
  @plan = nil
  @customer = nil
  @token = nil
  @url = ""
  @name = ""
  @amount = ""
  @currency = ""
  @metadata = Hash.new
  @interval = ""
  @trial_end_at = ""
  @activated = false
  @active = false
  @canceled = false
  @cancellation_reason = ""
  @pending_cancellation = false
  @cancel_at = ""
  @return_url = ""
  @cancel_url = ""
  @sandbox = false
  @created_at = ""
  @activated_at = ""
  @iterate_at = ""
  
end

Instance Attribute Details

#activated ⇒ Object

Returns the value of attribute activated.



22
23
24
 
# File 'lib/processout/subscription.rb', line 22

def activated
  @activated
end

#activated_at ⇒ Object

Returns the value of attribute activated_at.



32
33
34
 
# File 'lib/processout/subscription.rb', line 32

def activated_at
  @activated_at
end

#active ⇒ Object

Returns the value of attribute active.



23
24
25
 
# File 'lib/processout/subscription.rb', line 23

def active
  @active
end

#amount ⇒ Object

Returns the value of attribute amount.



17
18
19
 
# File 'lib/processout/subscription.rb', line 17

def amount
  @amount
end

#cancel_at(cancel_at, cancellation_reason, options = nil) ⇒ Object

Schedule the cancellation of the subscription. The reason may be provided as well. Params:

cancel_at

Cancellation date, in the form of a string

cancellation_reason

Cancellation reason

options

Hash of options



609
610
611
 
# File 'lib/processout/subscription.rb', line 609

def cancel_at
  @cancel_at
end

#cancel_url ⇒ Object

Returns the value of attribute cancel_url.



29
30
31
 
# File 'lib/processout/subscription.rb', line 29

def cancel_url
  @cancel_url
end

#canceled ⇒ Object

Returns the value of attribute canceled.



24
25
26
 
# File 'lib/processout/subscription.rb', line 24

def canceled
  @canceled
end

#cancellation_reason ⇒ Object

Returns the value of attribute cancellation_reason.



25
26
27
 
# File 'lib/processout/subscription.rb', line 25

def cancellation_reason
  @cancellation_reason
end

#created_at ⇒ Object

Returns the value of attribute created_at.



31
32
33
 
# File 'lib/processout/subscription.rb', line 31

def created_at
  @created_at
end

#currency ⇒ Object

Returns the value of attribute currency.



18
19
20
 
# File 'lib/processout/subscription.rb', line 18

def currency
  @currency
end

#customer(options = nil) ⇒ Object

Get the customer owning the subscription. Params:

options

Hash of options



277
278
279
 
# File 'lib/processout/subscription.rb', line 277

def customer
  @customer
end

#id ⇒ Object

Returns the value of attribute id.



10
11
12
 
# File 'lib/processout/subscription.rb', line 10

def id
  @id
end

#interval ⇒ Object

Returns the value of attribute interval.



20
21
22
 
# File 'lib/processout/subscription.rb', line 20

def interval
  @interval
end

#iterate_at ⇒ Object

Returns the value of attribute iterate_at.



33
34
35
 
# File 'lib/processout/subscription.rb', line 33

def iterate_at
  @iterate_at
end

#metadata ⇒ Object

Returns the value of attribute metadata.



19
20
21
 
# File 'lib/processout/subscription.rb', line 19

def metadata
  @metadata
end

#name ⇒ Object

Returns the value of attribute name.



16
17
18
 
# File 'lib/processout/subscription.rb', line 16

def name
  @name
end

#pending_cancellation ⇒ Object

Returns the value of attribute pending_cancellation.



26
27
28
 
# File 'lib/processout/subscription.rb', line 26

def pending_cancellation
  @pending_cancellation
end

#plan ⇒ Object

Returns the value of attribute plan.



12
13
14
 
# File 'lib/processout/subscription.rb', line 12

def plan
  @plan
end

#project ⇒ Object

Returns the value of attribute project.



11
12
13
 
# File 'lib/processout/subscription.rb', line 11

def project
  @project
end

#return_url ⇒ Object

Returns the value of attribute return_url.



28
29
30
 
# File 'lib/processout/subscription.rb', line 28

def return_url
  @return_url
end

#sandbox ⇒ Object

Returns the value of attribute sandbox.



30
31
32
 
# File 'lib/processout/subscription.rb', line 30

def sandbox
  @sandbox
end

#token ⇒ Object

Returns the value of attribute token.



14
15
16
 
# File 'lib/processout/subscription.rb', line 14

def token
  @token
end

#trial_end_at ⇒ Object

Returns the value of attribute trial_end_at.



21
22
23
 
# File 'lib/processout/subscription.rb', line 21

def trial_end_at
  @trial_end_at
end

#url ⇒ Object

Returns the value of attribute url.



15
16
17
 
# File 'lib/processout/subscription.rb', line 15

def url
  @url
end

Instance Method Details

#all(options = nil) ⇒ Object

Get all the subscriptions. Params:

options

Hash of options



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/processout/subscription.rb', line 380

def all(options = nil)
  request = Request.new(@client)
  path    = "/subscriptions"
  data    = {

  }

  response = Response.new(request.get(path, data, options))
  return_values = Array.new
  
  a    = Array.new
  body = response.body
  for v in body['subscriptions']
    tmp = Subscription(@client)
    tmp.fill_with_data(v)
    a.push(tmp)
  end

  return_values.push(a)
  

  
  return_values[0]
end

#apply_source(source, options = nil) ⇒ Object

Apply a source to the subscription to activate or update the subscription’s source. Params:

source

Source to be applied on the subscription and used to pay future invoices. Can be a card, a token or a gateway request

options

Hash of options



558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/processout/subscription.rb', line 558

def apply_source(source, options = nil)
  request = Request.new(@client)
  path    = "/subscriptions/" + CGI.escape(@id) + ""
  data    = {
    'source': source
  }

  response = Response.new(request.put(path, data, options))
  return_values = Array.new
  
  body = response.body
  body = body["subscription"]
  
  
  return_values.push(self.fill_with_data(body))
  

  
  return_values[0]
end

#cancel(cancellation_reason, options = nil) ⇒ Object

Cancel a subscription. The reason may be provided as well. Params:

cancellation_reason

Cancellation reason

options

Hash of options



583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
 
# File 'lib/processout/subscription.rb', line 583

def cancel(cancellation_reason, options = nil)
  request = Request.new(@client)
  path    = "/subscriptions/" + CGI.escape(@id) + ""
  data    = {
    'cancellation_reason': cancellation_reason
  }

  response = Response.new(request.delete(path, data, options))
  return_values = Array.new
  
  body = response.body
  body = body["subscription"]
  
  
  return_values.push(self.fill_with_data(body))
  

  
  return_values[0]
end

#create(customer_id, options = nil) ⇒ Object

Create a new subscription for the given customer. Params:

customer_id

ID of the customer

options

Hash of options



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/processout/subscription.rb', line 409

def create(customer_id, options = nil)
  request = Request.new(@client)
  path    = "/subscriptions"
  data    = {
    "cancel_at": @cancel_at, 
    "name": @name, 
    "amount": @amount, 
    "currency": @currency, 
    "metadata": @metadata, 
    "interval": @interval, 
    "trial_end_at": @trial_end_at, 
    "return_url": @return_url, 
    "cancel_url": @cancel_url, 
    'customer_id': customer_id
  }

  response = Response.new(request.post(path, data, options))
  return_values = Array.new
  
  body = response.body
  body = body["subscription"]
  
  
  return_values.push(self.fill_with_data(body))
  

  
  return_values[0]
end

#create_from_plan(customer_id, plan_id, options = nil) ⇒ Object

Create a new subscription for the customer from the given plan ID. Params:

customer_id

ID of the customer

plan_id

ID of the plan

options

Hash of options



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/processout/subscription.rb', line 444

def create_from_plan(customer_id, plan_id, options = nil)
  request = Request.new(@client)
  path    = "/subscriptions"
  data    = {
    "cancel_at": @cancel_at, 
    "name": @name, 
    "amount": @amount, 
    "currency": @currency, 
    "metadata": @metadata, 
    "interval": @interval, 
    "trial_end_at": @trial_end_at, 
    "return_url": @return_url, 
    "cancel_url": @cancel_url, 
    'customer_id': customer_id, 
    'plan_id': plan_id
  }

  response = Response.new(request.post(path, data, options))
  return_values = Array.new
  
  body = response.body
  body = body["subscription"]
  
  
  return_values.push(self.fill_with_data(body))
  

  
  return_values[0]
end

#discounts(options = nil) ⇒ Object

Get the discounts applied to the subscription. Params:

options

Hash of options



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/processout/subscription.rb', line 299

def discounts(options = nil)
  request = Request.new(@client)
  path    = "/subscriptions/" + CGI.escape(@id) + "/discounts"
  data    = {

  }

  response = Response.new(request.get(path, data, options))
  return_values = Array.new
  
  a    = Array.new
  body = response.body
  for v in body['discounts']
    tmp = Discount(@client)
    tmp.fill_with_data(v)
    a.push(tmp)
  end

  return_values.push(a)
  

  
  return_values[0]
end

#fill_with_data(data) ⇒ Object

Fills the object with data coming from the API Params:

data

Hash of data coming from the API



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/processout/subscription.rb', line 197

def fill_with_data(data)
  if data.include? "id"
    @id = data["id"]
  end
  if data.include? "project"
    @project = data["project"]
  end
  if data.include? "plan"
    @plan = data["plan"]
  end
  if data.include? "customer"
    @customer = data["customer"]
  end
  if data.include? "token"
    @token = data["token"]
  end
  if data.include? "url"
    @url = data["url"]
  end
  if data.include? "name"
    @name = data["name"]
  end
  if data.include? "amount"
    @amount = data["amount"]
  end
  if data.include? "currency"
    @currency = data["currency"]
  end
  if data.include? "metadata"
    @metadata = data["metadata"]
  end
  if data.include? "interval"
    @interval = data["interval"]
  end
  if data.include? "trial_end_at"
    @trial_end_at = data["trial_end_at"]
  end
  if data.include? "activated"
    @activated = data["activated"]
  end
  if data.include? "active"
    @active = data["active"]
  end
  if data.include? "canceled"
    @canceled = data["canceled"]
  end
  if data.include? "cancellation_reason"
    @cancellation_reason = data["cancellation_reason"]
  end
  if data.include? "pending_cancellation"
    @pending_cancellation = data["pending_cancellation"]
  end
  if data.include? "cancel_at"
    @cancel_at = data["cancel_at"]
  end
  if data.include? "return_url"
    @return_url = data["return_url"]
  end
  if data.include? "cancel_url"
    @cancel_url = data["cancel_url"]
  end
  if data.include? "sandbox"
    @sandbox = data["sandbox"]
  end
  if data.include? "created_at"
    @created_at = data["created_at"]
  end
  if data.include? "activated_at"
    @activated_at = data["activated_at"]
  end
  if data.include? "iterate_at"
    @iterate_at = data["iterate_at"]
  end
  
  self
end

#find(subscription_id, options = nil) ⇒ Object

Find a subscription by its ID. Params:

subscription_id

ID of the subscription

options

Hash of options



479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/processout/subscription.rb', line 479

def find(subscription_id, options = nil)
  request = Request.new(@client)
  path    = "/subscriptions/" + CGI.escape(subscription_id) + ""
  data    = {

  }

  response = Response.new(request.get(path, data, options))
  return_values = Array.new
  
  body = response.body
  body = body["subscription"]
  
  
  obj = Subscription.new(@client)
  return_values.push(obj.fill_with_data(body))
  

  
  return_values[0]
end

#remove_discount(discount_id, options = nil) ⇒ Object

Remove a discount applied to a subscription. Params:

discount_id

ID of the discount or coupon to be removed from the subscription

options

Hash of options



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/processout/subscription.rb', line 328

def remove_discount(discount_id, options = nil)
  request = Request.new(@client)
  path    = "/subscriptions/" + CGI.escape(@id) + "/discounts/" + CGI.escape(discount_id) + ""
  data    = {

  }

  response = Response.new(request.delete(path, data, options))
  return_values = Array.new
  
  body = response.body
  body = body["discount"]
  
  
  return_values.push(self.fill_with_data(body))
  

  
  return_values[0]
end

#transactions(options = nil) ⇒ Object

Get the subscriptions past transactions. Params:

options

Hash of options



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/processout/subscription.rb', line 352

def transactions(options = nil)
  request = Request.new(@client)
  path    = "/subscriptions/" + CGI.escape(@id) + "/transactions"
  data    = {

  }

  response = Response.new(request.get(path, data, options))
  return_values = Array.new
  
  a    = Array.new
  body = response.body
  for v in body['transactions']
    tmp = Transaction(@client)
    tmp.fill_with_data(v)
    a.push(tmp)
  end

  return_values.push(a)
  

  
  return_values[0]
end

#update(prorate, options = nil) ⇒ Object

Update the subscription. Params:

prorate

Define if proration should be done when updating the plan

options

Hash of options



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/processout/subscription.rb', line 505

def update(prorate, options = nil)
  request = Request.new(@client)
  path    = "/subscriptions/" + CGI.escape(@id) + ""
  data    = {
    "trial_end_at": @trial_end_at, 
    'prorate': prorate
  }

  response = Response.new(request.put(path, data, options))
  return_values = Array.new
  
  body = response.body
  body = body["subscription"]
  
  
  return_values.push(self.fill_with_data(body))
  

  
  return_values[0]
end

#update_plan(plan_id, prorate, options = nil) ⇒ Object

Update the subscription’s plan. Params:

plan_id

ID of the new plan to be applied on the subscription

prorate

Define if proration should be done when updating the plan

options

Hash of options



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/processout/subscription.rb', line 532

def update_plan(plan_id, prorate, options = nil)
  request = Request.new(@client)
  path    = "/subscriptions/" + CGI.escape(@id) + ""
  data    = {
    'plan_id': plan_id, 
    'prorate': prorate
  }

  response = Response.new(request.put(path, data, options))
  return_values = Array.new
  
  body = response.body
  body = body["subscription"]
  
  
  return_values.push(self.fill_with_data(body))
  

  
  return_values[0]
end