Class: Stripe::QuotePhase

Inherits:
APIResource show all
Extended by:
APIOperations::List
Defined in:
lib/stripe/resources/quote_phase.rb

Overview

A quote phase describes the line items, coupons, and trialing status of a subscription for a predefined time period.

Constant Summary collapse

OBJECT_NAME = 
"quote_phase"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::List

list

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Class Method Details

.list(filters = {}, opts = {}) ⇒ Object

Returns a list of quote phases.



15
16
17
 
# File 'lib/stripe/resources/quote_phase.rb', line 15

def self.list(filters = {}, opts = {})
  request_stripe_object(method: :get, path: "/v1/quote_phases", params: filters, opts: opts)
end

.list_line_items(quote_phase, params = {}, opts = {}) ⇒ Object

When retrieving a quote phase, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.



30
31
32
33
34
35
36
37
 
# File 'lib/stripe/resources/quote_phase.rb', line 30

def self.list_line_items(quote_phase, params = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: format("/v1/quote_phases/%<quote_phase>s/line_items", { quote_phase: CGI.escape(quote_phase) }),
    params: params,
    opts: opts
  )
end

.object_name ⇒ Object 



10
11
12
 
# File 'lib/stripe/resources/quote_phase.rb', line 10

def self.object_name
  "quote_phase"
end

Instance Method Details

#list_line_items(params = {}, opts = {}) ⇒ Object

When retrieving a quote phase, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.



20
21
22
23
24
25
26
27
 
# File 'lib/stripe/resources/quote_phase.rb', line 20

def list_line_items(params = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: format("/v1/quote_phases/%<quote_phase>s/line_items", { quote_phase: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end