Class: Stigg::Resources::V1::Subscriptions::FutureUpdate

Inherits:
Object
  • Object
show all
Defined in:
lib/stigg/resources/v1/subscriptions/future_update.rb

Overview

Operations related to subscriptions

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ FutureUpdate

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of FutureUpdate.

Parameters:



53
54
55
 
# File 'lib/stigg/resources/v1/subscriptions/future_update.rb', line 53

def initialize(client:)
  @client = client
end

Instance Method Details

#cancel_pending_payment(id, request_options: {}) ⇒ Stigg::Models::V1::Subscriptions::CancelSubscription

Cancels a subscription update that is pending payment completion.

Parameters:

  • id (String) —

    The unique identifier of the entity

  • request_options (Stigg::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



20
21
22
23
24
25
26
27
 
# File 'lib/stigg/resources/v1/subscriptions/future_update.rb', line 20

def cancel_pending_payment(id, params = {})
  @client.request(
    method: :delete,
    path: ["api/v1/subscriptions/%1$s/future-update/pending-payment", id],
    model: Stigg::V1::Subscriptions::CancelSubscription,
    options: params[:request_options]
  )
end

#cancel_schedule(id, request_options: {}) ⇒ Stigg::Models::V1::Subscriptions::CancelSubscription

Cancels a scheduled subscription update, such as a future downgrade or plan change.

Parameters:

  • id (String) —

    The unique identifier of the entity

  • request_options (Stigg::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



41
42
43
44
45
46
47
48
 
# File 'lib/stigg/resources/v1/subscriptions/future_update.rb', line 41

def cancel_schedule(id, params = {})
  @client.request(
    method: :delete,
    path: ["api/v1/subscriptions/%1$s/future-update/schedule", id],
    model: Stigg::V1::Subscriptions::CancelSubscription,
    options: params[:request_options]
  )
end