Class: Stripe::SubscriptionCreateParams

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

Defined Under Namespace

Classes: AddInvoiceItem, AutomaticTax, BillingCycleAnchorConfig, BillingMode, BillingSchedule, BillingThresholds, Discount, InvoiceSettings, Item, PaymentSettings, PendingInvoiceItemInterval, TransferData, TrialSettings

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, new, #to_h

Constructor Details

#initialize(add_invoice_items: nil, application_fee_percent: nil, automatic_tax: nil, backdate_start_date: nil, billing_cycle_anchor: nil, billing_cycle_anchor_config: nil, billing_mode: nil, billing_schedules: nil, billing_thresholds: nil, cancel_at: nil, cancel_at_period_end: nil, collection_method: nil, currency: nil, customer: nil, customer_account: nil, days_until_due: nil, default_payment_method: nil, default_source: nil, default_tax_rates: nil, description: nil, discounts: nil, expand: nil, invoice_settings: nil, items: nil, metadata: nil, off_session: nil, on_behalf_of: nil, payment_behavior: nil, payment_settings: nil, pending_invoice_item_interval: nil, proration_behavior: nil, transfer_data: nil, trial_end: nil, trial_from_plan: nil, trial_period_days: nil, trial_settings: nil) ⇒ SubscriptionCreateParams

Returns a new instance of SubscriptionCreateParams.



822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
 
# File 'lib/stripe/params/subscription_create_params.rb', line 822

def initialize(
  add_invoice_items: nil,
  application_fee_percent: nil,
  automatic_tax: nil,
  backdate_start_date: nil,
  billing_cycle_anchor: nil,
  billing_cycle_anchor_config: nil,
  billing_mode: nil,
  billing_schedules: nil,
  billing_thresholds: nil,
  cancel_at: nil,
  cancel_at_period_end: nil,
  collection_method: nil,
  currency: nil,
  customer: nil,
  customer_account: nil,
  days_until_due: nil,
  default_payment_method: nil,
  default_source: nil,
  default_tax_rates: nil,
  description: nil,
  discounts: nil,
  expand: nil,
  invoice_settings: nil,
  items: nil,
  metadata: nil,
  off_session: nil,
  on_behalf_of: nil,
  payment_behavior: nil,
  payment_settings: nil,
  pending_invoice_item_interval: nil,
  proration_behavior: nil,
  transfer_data: nil,
  trial_end: nil,
  trial_from_plan: nil,
  trial_period_days: nil,
  trial_settings: nil
)
  @add_invoice_items = add_invoice_items
  @application_fee_percent = application_fee_percent
  @automatic_tax = automatic_tax
  @backdate_start_date = backdate_start_date
  @billing_cycle_anchor = billing_cycle_anchor
  @billing_cycle_anchor_config = billing_cycle_anchor_config
  @billing_mode = billing_mode
  @billing_schedules = billing_schedules
  @billing_thresholds = billing_thresholds
  @cancel_at = cancel_at
  @cancel_at_period_end = cancel_at_period_end
  @collection_method = collection_method
  @currency = currency
  @customer = customer
  @customer_account = 
  @days_until_due = days_until_due
  @default_payment_method = default_payment_method
  @default_source = default_source
  @default_tax_rates = default_tax_rates
  @description = description
  @discounts = discounts
  @expand = expand
  @invoice_settings = invoice_settings
  @items = items
  @metadata = metadata
  @off_session = off_session
  @on_behalf_of = on_behalf_of
  @payment_behavior = payment_behavior
  @payment_settings = payment_settings
  @pending_invoice_item_interval = pending_invoice_item_interval
  @proration_behavior = proration_behavior
  @transfer_data = transfer_data
  @trial_end = trial_end
  @trial_from_plan = trial_from_plan
  @trial_period_days = trial_period_days
  @trial_settings = trial_settings
end

Instance Attribute Details

#add_invoice_items ⇒ Object

A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.



750
751
752
 
# File 'lib/stripe/params/subscription_create_params.rb', line 750

def add_invoice_items
  @add_invoice_items
end

#application_fee_percent ⇒ Object

A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees documentation.



752
753
754
 
# File 'lib/stripe/params/subscription_create_params.rb', line 752

def application_fee_percent
  @application_fee_percent
end

#automatic_tax ⇒ Object

Automatic tax settings for this subscription.



754
755
756
 
# File 'lib/stripe/params/subscription_create_params.rb', line 754

def automatic_tax
  @automatic_tax
end

#backdate_start_date ⇒ Object

A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.



756
757
758
 
# File 'lib/stripe/params/subscription_create_params.rb', line 756

def backdate_start_date
  @backdate_start_date
end

#billing_cycle_anchor ⇒ Object

A future timestamp in UTC format to anchor the subscription's billing cycle. The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals.



758
759
760
 
# File 'lib/stripe/params/subscription_create_params.rb', line 758

def billing_cycle_anchor
  @billing_cycle_anchor
end

#billing_cycle_anchor_config ⇒ Object

Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurrence of the day_of_month at the hour, minute, and second UTC.



760
761
762
 
# File 'lib/stripe/params/subscription_create_params.rb', line 760

def billing_cycle_anchor_config
  @billing_cycle_anchor_config
end

#billing_mode ⇒ Object

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



762
763
764
 
# File 'lib/stripe/params/subscription_create_params.rb', line 762

def billing_mode
  @billing_mode
end

#billing_schedules ⇒ Object

Sets the billing schedules for the subscription.



764
765
766
 
# File 'lib/stripe/params/subscription_create_params.rb', line 764

def billing_schedules
  @billing_schedules
end

#billing_thresholds ⇒ Object

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.



766
767
768
 
# File 'lib/stripe/params/subscription_create_params.rb', line 766

def billing_thresholds
  @billing_thresholds
end

#cancel_at ⇒ Object

A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using proration_behavior. If set during a future period, this will always cause a proration for that period.



768
769
770
 
# File 'lib/stripe/params/subscription_create_params.rb', line 768

def cancel_at
  @cancel_at
end

#cancel_at_period_end ⇒ Object

Indicate whether this subscription should cancel at the end of the current period (current_period_end). Defaults to false.



770
771
772
 
# File 'lib/stripe/params/subscription_create_params.rb', line 770

def cancel_at_period_end
  @cancel_at_period_end
end

#collection_method ⇒ Object

Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active. Defaults to charge_automatically.



772
773
774
 
# File 'lib/stripe/params/subscription_create_params.rb', line 772

def collection_method
  @collection_method
end

#currency ⇒ Object

Three-letter ISO currency code, in lowercase. Must be a supported currency.



774
775
776
 
# File 'lib/stripe/params/subscription_create_params.rb', line 774

def currency
  @currency
end

#customer ⇒ Object

The identifier of the customer to subscribe.



776
777
778
 
# File 'lib/stripe/params/subscription_create_params.rb', line 776

def customer
  @customer
end

#customer_account ⇒ Object

The identifier of the account representing the customer to subscribe.



778
779
780
 
# File 'lib/stripe/params/subscription_create_params.rb', line 778

def 
  @customer_account
end

#days_until_due ⇒ Object

Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where collection_method is set to send_invoice.



780
781
782
 
# File 'lib/stripe/params/subscription_create_params.rb', line 780

def days_until_due
  @days_until_due
end

#default_payment_method ⇒ Object

ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.



782
783
784
 
# File 'lib/stripe/params/subscription_create_params.rb', line 782

def default_payment_method
  @default_payment_method
end

#default_source ⇒ Object

ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.



784
785
786
 
# File 'lib/stripe/params/subscription_create_params.rb', line 784

def default_source
  @default_source
end

#default_tax_rates ⇒ Object

The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.



786
787
788
 
# File 'lib/stripe/params/subscription_create_params.rb', line 786

def default_tax_rates
  @default_tax_rates
end

#description ⇒ Object

The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.



788
789
790
 
# File 'lib/stripe/params/subscription_create_params.rb', line 788

def description
  @description
end

#discounts ⇒ Object

The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer.



790
791
792
 
# File 'lib/stripe/params/subscription_create_params.rb', line 790

def discounts
  @discounts
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



792
793
794
 
# File 'lib/stripe/params/subscription_create_params.rb', line 792

def expand
  @expand
end

#invoice_settings ⇒ Object

All invoices will be billed using the specified settings.



794
795
796
 
# File 'lib/stripe/params/subscription_create_params.rb', line 794

def invoice_settings
  @invoice_settings
end

#items ⇒ Object

A list of up to 20 subscription items, each with an attached price.



796
797
798
 
# File 'lib/stripe/params/subscription_create_params.rb', line 796

def items
  @items
end

#metadata ⇒ Object

Set of key-value pairs 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.



798
799
800
 
# File 'lib/stripe/params/subscription_create_params.rb', line 798

def metadata
  @metadata
end

#off_session ⇒ Object

Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to false (on-session).



800
801
802
 
# File 'lib/stripe/params/subscription_create_params.rb', line 800

def off_session
  @off_session
end

#on_behalf_of ⇒ Object

The account on behalf of which to charge, for each of the subscription's invoices.



802
803
804
 
# File 'lib/stripe/params/subscription_create_params.rb', line 802

def on_behalf_of
  @on_behalf_of
end

#payment_behavior ⇒ Object

Controls how Stripe handles the first invoice when payment is required and collection_method=charge_automatically. Subscriptions with collection_method=send_invoice are automatically activated regardless of the first Invoice status.



804
805
806
 
# File 'lib/stripe/params/subscription_create_params.rb', line 804

def payment_behavior
  @payment_behavior
end

#payment_settings ⇒ Object

Payment settings to pass to invoices created by the subscription.



806
807
808
 
# File 'lib/stripe/params/subscription_create_params.rb', line 806

def payment_settings
  @payment_settings
end

#pending_invoice_item_interval ⇒ Object

Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.



808
809
810
 
# File 'lib/stripe/params/subscription_create_params.rb', line 808

def pending_invoice_item_interval
  @pending_invoice_item_interval
end

#proration_behavior ⇒ Object

Determines how to handle prorations resulting from the billing_cycle_anchor. If no value is passed, the default is create_prorations.



810
811
812
 
# File 'lib/stripe/params/subscription_create_params.rb', line 810

def proration_behavior
  @proration_behavior
end

#transfer_data ⇒ Object

If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.



812
813
814
 
# File 'lib/stripe/params/subscription_create_params.rb', line 812

def transfer_data
  @transfer_data
end

#trial_end ⇒ Object

Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value now can be provided to end the customer's trial immediately. Can be at most two years from billing_cycle_anchor. See Using trial periods on subscriptions to learn more.



814
815
816
 
# File 'lib/stripe/params/subscription_create_params.rb', line 814

def trial_end
  @trial_end
end

#trial_from_plan ⇒ Object

Indicates if a plan's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. See Using trial periods on subscriptions to learn more.



816
817
818
 
# File 'lib/stripe/params/subscription_create_params.rb', line 816

def trial_from_plan
  @trial_from_plan
end

#trial_period_days ⇒ Object

Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See Using trial periods on subscriptions to learn more.



818
819
820
 
# File 'lib/stripe/params/subscription_create_params.rb', line 818

def trial_period_days
  @trial_period_days
end

#trial_settings ⇒ Object

Settings related to subscription trials.



820
821
822
 
# File 'lib/stripe/params/subscription_create_params.rb', line 820

def trial_settings
  @trial_settings
end

Class Method Details

.field_encodings ⇒ Object 



898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
 
# File 'lib/stripe/params/subscription_create_params.rb', line 898

def self.field_encodings
  @field_encodings = {
    add_invoice_items: {
      kind: :array,
      element: {
        kind: :object,
        fields: { price_data: { kind: :object, fields: { unit_amount_decimal: :decimal_string } } },
      },
    },
    items: {
      kind: :array,
      element: {
        kind: :object,
        fields: { price_data: { kind: :object, fields: { unit_amount_decimal: :decimal_string } } },
      },
    },
  }
end