Sha256: f7e8a3ef98458f2e8d820ee083b6263d42a3fff3d14549bf8fbe9d417ec00ee8

Contents?: true

Size: 1.58 KB

Versions: 12

Compression:

Stored size: 1.58 KB

Contents

# File generated from our OpenAPI spec
# frozen_string_literal: true

module Stripe
  # A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.
  #
  # Related guide: [Subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules)
  class SubscriptionSchedule < APIResource
    extend Stripe::APIOperations::Create
    extend Stripe::APIOperations::List
    include Stripe::APIOperations::Save

    OBJECT_NAME = "subscription_schedule"

    def cancel(params = {}, opts = {})
      request_stripe_object(
        method: :post,
        path: format("/v1/subscription_schedules/%<schedule>s/cancel", { schedule: CGI.escape(self["id"]) }),
        params: params,
        opts: opts
      )
    end

    def release(params = {}, opts = {})
      request_stripe_object(
        method: :post,
        path: format("/v1/subscription_schedules/%<schedule>s/release", { schedule: CGI.escape(self["id"]) }),
        params: params,
        opts: opts
      )
    end

    def self.cancel(schedule, params = {}, opts = {})
      request_stripe_object(
        method: :post,
        path: format("/v1/subscription_schedules/%<schedule>s/cancel", { schedule: CGI.escape(schedule) }),
        params: params,
        opts: opts
      )
    end

    def self.release(schedule, params = {}, opts = {})
      request_stripe_object(
        method: :post,
        path: format("/v1/subscription_schedules/%<schedule>s/release", { schedule: CGI.escape(schedule) }),
        params: params,
        opts: opts
      )
    end
  end
end

Version data entries

12 entries across 12 versions & 1 rubygems

Version Path
stripe-10.4.0 lib/stripe/resources/subscription_schedule.rb
stripe-10.3.0 lib/stripe/resources/subscription_schedule.rb
stripe-10.2.0 lib/stripe/resources/subscription_schedule.rb
stripe-10.1.0 lib/stripe/resources/subscription_schedule.rb
stripe-10.0.0 lib/stripe/resources/subscription_schedule.rb
stripe-9.4.0 lib/stripe/resources/subscription_schedule.rb
stripe-9.3.0 lib/stripe/resources/subscription_schedule.rb
stripe-9.2.0 lib/stripe/resources/subscription_schedule.rb
stripe-9.1.0 lib/stripe/resources/subscription_schedule.rb
stripe-9.0.0 lib/stripe/resources/subscription_schedule.rb
stripe-8.7.0 lib/stripe/resources/subscription_schedule.rb
stripe-8.6.0 lib/stripe/resources/subscription_schedule.rb