Class: Stripe::SubscriptionScheduleCreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/subscription_schedule_create_params.rb

Defined Under Namespace

Classes: BillingMode, DefaultSettings, Phase

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(billing_mode: nil, customer: nil, customer_account: nil, default_settings: nil, end_behavior: nil, expand: nil, from_subscription: nil, metadata: nil, phases: nil, start_date: nil) ⇒ SubscriptionScheduleCreateParams

Returns a new instance of SubscriptionScheduleCreateParams.



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 570

def initialize(
  billing_mode: nil,
  customer: nil,
  customer_account: nil,
  default_settings: nil,
  end_behavior: nil,
  expand: nil,
  from_subscription: nil,
  metadata: nil,
  phases: nil,
  start_date: nil
)
  @billing_mode = billing_mode
  @customer = customer
  @customer_account = 
  @default_settings = default_settings
  @end_behavior = end_behavior
  @expand = expand
  @from_subscription = from_subscription
  @metadata = metadata
  @phases = phases
  @start_date = start_date
end

Instance Attribute Details

#billing_mode ⇒ Object

Controls how prorations and invoices for subscriptions are calculated and orchestrated.



550
551
552
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 550

def billing_mode
  @billing_mode
end

#customer ⇒ Object

The identifier of the customer to create the subscription schedule for.



552
553
554
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 552

def customer
  @customer
end

#customer_account ⇒ Object

The identifier of the account to create the subscription schedule for.



554
555
556
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 554

def 
  @customer_account
end

#default_settings ⇒ Object

Object representing the subscription schedule’s default settings.



556
557
558
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 556

def default_settings
  @default_settings
end

#end_behavior ⇒ Object

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.



558
559
560
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 558

def end_behavior
  @end_behavior
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



560
561
562
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 560

def expand
  @expand
end

#from_subscription ⇒ Object

Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription’s item(s), set to auto-renew using the subscription’s interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.



562
563
564
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 562

def from_subscription
  @from_subscription
end

#metadata ⇒ Object

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.



564
565
566
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 564

def metadata
  @metadata
end

#phases ⇒ Object

List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the end_date of one phase will always equal the start_date of the next phase.



566
567
568
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 566

def phases
  @phases
end

#start_date ⇒ Object

When the subscription schedule starts. We recommend using now so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.



568
569
570
 
# File 'lib/stripe/params/subscription_schedule_create_params.rb', line 568

def start_date
  @start_date
end