Class: Stripe::SubscriptionSchedule

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/subscription_schedule.rb

Overview

A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.

Related guide: [Subscription schedules](docs.stripe.com/billing/subscriptions/subscription-schedules)

Defined Under Namespace

Classes: BillingMode, BillingSchedule, CurrentPhase, DefaultSettings, LastPriceMigrationError, Phase, Prebilling

Constant Summary collapse

OBJECT_NAME = 
"subscription_schedule"

Constants inherited from StripeObject

Stripe::StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

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::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

included, #save

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

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, field_encodings, #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

Instance Attribute Details

#application ⇒ Object (readonly)

ID of the Connect Application that created the schedule.



830
831
832
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 830

def application
  @application
end

#billing_behavior ⇒ Object (readonly)

Configures when the subscription schedule generates prorations for phase transitions. Possible values are ‘prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.



832
833
834
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 832

def billing_behavior
  @billing_behavior
end

#billing_mode ⇒ Object (readonly)

The billing mode of the subscription.



834
835
836
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 834

def billing_mode
  @billing_mode
end

#billing_schedules ⇒ Object (readonly)

Billing schedules for this subscription schedule.



836
837
838
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 836

def billing_schedules
  @billing_schedules
end

#canceled_at ⇒ Object (readonly)

Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.



838
839
840
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 838

def canceled_at
  @canceled_at
end

#completed_at ⇒ Object (readonly)

Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.



840
841
842
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 840

def completed_at
  @completed_at
end

#created ⇒ Object (readonly)

Time at which the object was created. Measured in seconds since the Unix epoch.



842
843
844
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 842

def created
  @created
end

#current_phase ⇒ Object (readonly)

Object representing the start and end dates for the current phase of the subscription schedule, if it is ‘active`.



844
845
846
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 844

def current_phase
  @current_phase
end

#customer ⇒ Object (readonly)

ID of the customer who owns the subscription schedule.



846
847
848
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 846

def customer
  @customer
end

#customer_account ⇒ Object (readonly)

ID of the account who owns the subscription schedule.



848
849
850
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 848

def 
  @customer_account
end

#default_settings ⇒ Object (readonly)

Attribute for field default_settings



850
851
852
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 850

def default_settings
  @default_settings
end

#end_behavior ⇒ Object (readonly)

Behavior of the subscription schedule and underlying subscription when it ends. Possible values are ‘release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.



852
853
854
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 852

def end_behavior
  @end_behavior
end

#id ⇒ Object (readonly)

Unique identifier for the object.



854
855
856
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 854

def id
  @id
end

#last_price_migration_error ⇒ Object (readonly)

Details of the most recent price migration that failed for the subscription schedule.



856
857
858
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 856

def last_price_migration_error
  @last_price_migration_error
end

#latest_invoice ⇒ Object (readonly)

The most recent invoice this subscription schedule has generated.



858
859
860
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 858

def latest_invoice
  @latest_invoice
end

#livemode ⇒ Object (readonly)

If the object exists in live mode, the value is ‘true`. If the object exists in test mode, the value is `false`.



860
861
862
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 860

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

Set of [key-value pairs](docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.



862
863
864
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 862

def metadata
  @metadata
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



864
865
866
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 864

def object
  @object
end

#phases ⇒ Object (readonly)

Configuration for the subscription schedule’s phases.



866
867
868
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 866

def phases
  @phases
end

#prebilling ⇒ Object (readonly)

Time period and invoice for a Subscription billed in advance.



868
869
870
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 868

def prebilling
  @prebilling
end

#released_at ⇒ Object (readonly)

Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.



870
871
872
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 870

def released_at
  @released_at
end

#released_subscription ⇒ Object (readonly)

ID of the subscription once managed by the subscription schedule (if it is released).



872
873
874
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 872

def released_subscription
  @released_subscription
end

#status ⇒ Object (readonly)

The present status of the subscription schedule. Possible values are ‘not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](docs.stripe.com/billing/subscriptions/subscription-schedules).



874
875
876
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 874

def status
  @status
end

#subscription ⇒ Object (readonly)

ID of the subscription managed by the subscription schedule.



876
877
878
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 876

def subscription
  @subscription
end

#test_clock ⇒ Object (readonly)

ID of the test clock this subscription schedule belongs to.



878
879
880
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 878

def test_clock
  @test_clock
end

Class Method Details

.amend(schedule, params = {}, opts = {}) ⇒ Object

Amends an existing subscription schedule.



891
892
893
894
895
896
897
898
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 891

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

.cancel(schedule, params = {}, opts = {}) ⇒ Object

Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.



911
912
913
914
915
916
917
918
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 911

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

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

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.



921
922
923
924
925
926
927
928
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 921

def self.create(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: "/v1/subscription_schedules",
    params: params,
    opts: opts
  )
end

.field_remappings ⇒ Object 



982
983
984
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 982

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



970
971
972
973
974
975
976
977
978
979
980
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 970

def self.inner_class_types
  @inner_class_types = {
    billing_mode: BillingMode,
    billing_schedules: BillingSchedule,
    current_phase: CurrentPhase,
    default_settings: DefaultSettings,
    last_price_migration_error: LastPriceMigrationError,
    phases: Phase,
    prebilling: Prebilling,
  }
end

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

Retrieves the list of your subscription schedules.



931
932
933
934
935
936
937
938
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 931

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

.object_name ⇒ Object 



14
15
16
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 14

def self.object_name
  "subscription_schedule"
end

.release(schedule, params = {}, opts = {}) ⇒ Object

Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription’s ID to the released_subscription property.



951
952
953
954
955
956
957
958
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 951

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

.update(schedule, params = {}, opts = {}) ⇒ Object

Updates an existing subscription schedule.



961
962
963
964
965
966
967
968
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 961

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

Instance Method Details

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

Amends an existing subscription schedule.



881
882
883
884
885
886
887
888
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 881

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

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

Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.



901
902
903
904
905
906
907
908
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 901

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

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

Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription’s ID to the released_subscription property.



941
942
943
944
945
946
947
948
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 941

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