Class: Orb::Models::SubscriptionCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/orb/models/subscription_create_params.rb

Overview

See Also:

Defined Under Namespace

Modules: ExternalMarketplace Classes: AddAdjustment, AddPrice, RemoveAdjustment, RemovePrice, ReplaceAdjustment, ReplacePrice

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(external_price_id: nil, price_id: nil) ⇒ Object

Parameters:

  • external_price_id (String, nil) (defaults to: nil) —

    The external price id of the price to remove on the subscription.

  • price_id (String, nil) (defaults to: nil) —

    The id of the price to remove on the subscription.




# File 'lib/orb/models/subscription_create_params.rb', line 573

Instance Attribute Details

#add_adjustments ⇒ Array<Orb::Models::SubscriptionCreateParams::AddAdjustment>?

Additional adjustments to be added to the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)

Returns:



15
16
17
 
# File 'lib/orb/models/subscription_create_params.rb', line 15

optional :add_adjustments,
-> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionCreateParams::AddAdjustment] },
nil?: true

#add_prices ⇒ Array<Orb::Models::SubscriptionCreateParams::AddPrice>?

Additional prices to be added to the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)

Returns:



24
25
26
 
# File 'lib/orb/models/subscription_create_params.rb', line 24

optional :add_prices,
-> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionCreateParams::AddPrice] },
nil?: true

#align_billing_with_subscription_start_date ⇒ Boolean?

Returns:

  • (Boolean, nil) 


31
 
# File 'lib/orb/models/subscription_create_params.rb', line 31

optional :align_billing_with_subscription_start_date, Orb::Internal::Type::Boolean

#auto_collection ⇒ Boolean?

Determines whether issued invoices for this subscription will automatically be charged with the saved payment method on the due date. If not specified, this defaults to the behavior configured for this customer.

Returns:

  • (Boolean, nil) 


39
 
# File 'lib/orb/models/subscription_create_params.rb', line 39

optional :auto_collection, Orb::Internal::Type::Boolean, nil?: true

#aws_region ⇒ String?

Deprecated.

Returns:

  • (String, nil) 


45
 
# File 'lib/orb/models/subscription_create_params.rb', line 45

optional :aws_region, String, nil?: true

#billing_cycle_anchor_configuration ⇒ Orb::Models::BillingCycleAnchorConfiguration?

Returns:



50
 
# File 'lib/orb/models/subscription_create_params.rb', line 50

optional :billing_cycle_anchor_configuration, -> { Orb::BillingCycleAnchorConfiguration }, nil?: true

#coupon_redemption_code ⇒ String?

Redemption code to be used for this subscription. If the coupon cannot be found by its redemption code, or cannot be redeemed, an error response will be returned and the subscription creation or plan change will not be scheduled.

Returns:

  • (String, nil) 


58
 
# File 'lib/orb/models/subscription_create_params.rb', line 58

optional :coupon_redemption_code, String, nil?: true

#credits_overage_rate ⇒ Float?

Deprecated.

Returns:

  • (Float, nil) 


64
 
# File 'lib/orb/models/subscription_create_params.rb', line 64

optional :credits_overage_rate, Float, nil?: true

#currency ⇒ String?

The currency to use for the subscription. If not specified, the invoicing currency for the plan will be used.

Returns:

  • (String, nil) 


71
 
# File 'lib/orb/models/subscription_create_params.rb', line 71

optional :currency, String, nil?: true

#customer_id ⇒ String?

Returns:

  • (String, nil) 


76
 
# File 'lib/orb/models/subscription_create_params.rb', line 76

optional :customer_id, String, nil?: true

#default_invoice_memo ⇒ String?

Determines the default memo on this subscription’s invoices. Note that if this is not provided, it is determined by the plan configuration.

Returns:

  • (String, nil) 


83
 
# File 'lib/orb/models/subscription_create_params.rb', line 83

optional :default_invoice_memo, String, nil?: true

#end_date ⇒ Time?

Returns:

  • (Time, nil) 


88
 
# File 'lib/orb/models/subscription_create_params.rb', line 88

optional :end_date, Time, nil?: true

#external_customer_id ⇒ String?

Returns:

  • (String, nil) 


93
 
# File 'lib/orb/models/subscription_create_params.rb', line 93

optional :external_customer_id, String, nil?: true

#external_marketplace ⇒ Symbol, ...

Deprecated.

Returns:



99
100
101
 
# File 'lib/orb/models/subscription_create_params.rb', line 99

optional :external_marketplace,
enum: -> { Orb::SubscriptionCreateParams::ExternalMarketplace },
nil?: true

#external_marketplace_reporting_id ⇒ String?

Deprecated.

Returns:

  • (String, nil) 


107
 
# File 'lib/orb/models/subscription_create_params.rb', line 107

optional :external_marketplace_reporting_id, String, nil?: true

#external_plan_id ⇒ String?

The external_plan_id of the plan that the given subscription should be switched to. Note that either this property or ‘plan_id` must be specified.

Returns:

  • (String, nil) 


114
 
# File 'lib/orb/models/subscription_create_params.rb', line 114

optional :external_plan_id, String, nil?: true

#filter ⇒ String?

An additional filter to apply to usage queries. This filter must be expressed as a boolean [computed property](/extensibility/advanced-metrics#computed-properties). If null, usage queries will not include any additional filter.

Returns:

  • (String, nil) 


123
 
# File 'lib/orb/models/subscription_create_params.rb', line 123

optional :filter, String, nil?: true

#initial_phase_order ⇒ Integer?

The phase of the plan to start with

Returns:

  • (Integer, nil) 


129
 
# File 'lib/orb/models/subscription_create_params.rb', line 129

optional :initial_phase_order, Integer, nil?: true

#invoicing_threshold ⇒ String?

When this subscription’s accrued usage reaches this threshold, an invoice will be issued for the subscription. If not specified, invoices will only be issued at the end of the billing period.

Returns:

  • (String, nil) 


137
 
# File 'lib/orb/models/subscription_create_params.rb', line 137

optional :invoicing_threshold, String, nil?: true

#metadata ⇒ Hash{Symbol=>String, nil}?

User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to ‘null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.

Returns:

  • (Hash{Symbol=>String, nil}, nil) 


145
 
# File 'lib/orb/models/subscription_create_params.rb', line 145

optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true

#name ⇒ String?

The name to use for the subscription. If not specified, the plan name will be used.

Returns:

  • (String, nil) 


152
 
# File 'lib/orb/models/subscription_create_params.rb', line 152

optional :name, String, nil?: true

#net_terms ⇒ Integer?

The net terms determines the difference between the invoice date and the issue date for the invoice. If you intend the invoice to be due on issue, set this to 0. If not provided, this defaults to the value specified in the plan.

Returns:

  • (Integer, nil) 


160
 
# File 'lib/orb/models/subscription_create_params.rb', line 160

optional :net_terms, Integer, nil?: true

#per_credit_overage_amount ⇒ Float?

Deprecated.

Returns:

  • (Float, nil) 


166
 
# File 'lib/orb/models/subscription_create_params.rb', line 166

optional :per_credit_overage_amount, Float, nil?: true

#plan_id ⇒ String?

The plan that the given subscription should be switched to. Note that either this property or ‘external_plan_id` must be specified.

Returns:

  • (String, nil) 


173
 
# File 'lib/orb/models/subscription_create_params.rb', line 173

optional :plan_id, String, nil?: true

#plan_version_number ⇒ Integer?

Specifies which version of the plan to subscribe to. If null, the default version will be used.

Returns:

  • (Integer, nil) 


180
 
# File 'lib/orb/models/subscription_create_params.rb', line 180

optional :plan_version_number, Integer, nil?: true

#price_overrides ⇒ Array<Object>?

Deprecated.

Optionally provide a list of overrides for prices on the plan

Returns:

  • (Array<Object>, nil) 


188
 
# File 'lib/orb/models/subscription_create_params.rb', line 188

optional :price_overrides, Orb::Internal::Type::ArrayOf[Orb::Internal::Type::Unknown], nil?: true

#remove_adjustments ⇒ Array<Orb::Models::SubscriptionCreateParams::RemoveAdjustment>?

Plan adjustments to be removed from the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)

Returns:



195
196
197
 
# File 'lib/orb/models/subscription_create_params.rb', line 195

optional :remove_adjustments,
-> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionCreateParams::RemoveAdjustment] },
nil?: true

#remove_prices ⇒ Array<Orb::Models::SubscriptionCreateParams::RemovePrice>?

Plan prices to be removed from the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)

Returns:



204
205
206
 
# File 'lib/orb/models/subscription_create_params.rb', line 204

optional :remove_prices,
-> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionCreateParams::RemovePrice] },
nil?: true

#replace_adjustments ⇒ Array<Orb::Models::SubscriptionCreateParams::ReplaceAdjustment>?

Plan adjustments to be replaced with additional adjustments on the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)

Returns:



214
215
216
 
# File 'lib/orb/models/subscription_create_params.rb', line 214

optional :replace_adjustments,
-> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionCreateParams::ReplaceAdjustment] },
nil?: true

#replace_prices ⇒ Array<Orb::Models::SubscriptionCreateParams::ReplacePrice>?

Plan prices to be replaced with additional prices on the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)

Returns:



223
224
225
 
# File 'lib/orb/models/subscription_create_params.rb', line 223

optional :replace_prices,
-> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionCreateParams::ReplacePrice] },
nil?: true

#start_date ⇒ Time?

Returns:

  • (Time, nil) 


230
 
# File 'lib/orb/models/subscription_create_params.rb', line 230

optional :start_date, Time, nil?: true

#trial_duration_days ⇒ Integer?

The duration of the trial period in days. If not provided, this defaults to the value specified in the plan. If ‘0` is provided, the trial on the plan will be skipped.

Returns:

  • (Integer, nil) 


238
 
# File 'lib/orb/models/subscription_create_params.rb', line 238

optional :trial_duration_days, Integer, nil?: true

#usage_customer_ids ⇒ Array<String>?

A list of customer IDs whose usage events will be aggregated and billed under this subscription. By default, a subscription only considers usage events associated with its attached customer’s customer_id. When usage_customer_ids is provided, the subscription includes usage events from the specified customers only. Provided usage_customer_ids must be either the customer for this subscription itself, or any of that customer’s children.

Returns:

  • (Array<String>, nil) 


249
 
# File 'lib/orb/models/subscription_create_params.rb', line 249

optional :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/orb/models/subscription_create_params.rb', line 562

.variants ⇒ Array(Orb::Models::NewPercentageDiscount, Orb::Models::NewUsageDiscount, Orb::Models::NewAmountDiscount, Orb::Models::NewMinimum, Orb::Models::NewMaximum)

Returns:




# File 'lib/orb/models/subscription_create_params.rb', line 381