Class: Stripe::V2::Billing::RateCardSubscriptionService

Inherits:
StripeService
  • Object
show all
Defined in:
lib/stripe/services/v2/billing/rate_card_subscription_service.rb

Defined Under Namespace

Classes: CancelParams, CreateParams, ListParams, RetrieveParams, UpdateParams

Instance Method Summary collapse

Methods inherited from StripeService

#initialize, #request, #request_stream

Constructor Details

This class inherits a constructor from Stripe::StripeService

Instance Method Details

#cancel(id, params = {}, opts = {}) ⇒ Object

Cancel an existing, active Rate Card Subscription.



88
89
90
91
92
93
94
95
96
 
# File 'lib/stripe/services/v2/billing/rate_card_subscription_service.rb', line 88

def cancel(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v2/billing/rate_card_subscriptions/%<id>s/cancel", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

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

Create a Rate Card Subscription to bill a Rate Card on a specified Billing Cadence.



99
100
101
102
103
104
105
106
107
 
# File 'lib/stripe/services/v2/billing/rate_card_subscription_service.rb', line 99

def create(params = {}, opts = {})
  request(
    method: :post,
    path: "/v2/billing/rate_card_subscriptions",
    params: params,
    opts: opts,
    base_address: :api
  )
end

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

List all Rate Card Subscription objects.



110
111
112
113
114
115
116
117
118
 
# File 'lib/stripe/services/v2/billing/rate_card_subscription_service.rb', line 110

def list(params = {}, opts = {})
  request(
    method: :get,
    path: "/v2/billing/rate_card_subscriptions",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#retrieve(id, params = {}, opts = {}) ⇒ Object

Retrieve a Rate Card Subscription by ID.



121
122
123
124
125
126
127
128
129
 
# File 'lib/stripe/services/v2/billing/rate_card_subscription_service.rb', line 121

def retrieve(id, params = {}, opts = {})
  request(
    method: :get,
    path: format("/v2/billing/rate_card_subscriptions/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#update(id, params = {}, opts = {}) ⇒ Object

Update fields on an existing, active Rate Card Subscription.



132
133
134
135
136
137
138
139
140
 
# File 'lib/stripe/services/v2/billing/rate_card_subscription_service.rb', line 132

def update(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v2/billing/rate_card_subscriptions/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end