orb-billing 0.5.2 → 0.5.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +25 -0
- data/README.md +4 -4
- data/SECURITY.md +2 -2
- data/lib/orb/internal/util.rb +3 -1
- data/lib/orb/internal.rb +3 -0
- data/lib/orb/models/alert.rb +23 -23
- data/lib/orb/models/alert_create_for_customer_params.rb +5 -5
- data/lib/orb/models/alert_create_for_external_customer_params.rb +5 -5
- data/lib/orb/models/alert_create_for_subscription_params.rb +5 -5
- data/lib/orb/models/alert_update_params.rb +3 -3
- data/lib/orb/models/amount_discount.rb +5 -5
- data/lib/orb/models/billable_metric.rb +7 -7
- data/lib/orb/models/coupon.rb +6 -6
- data/lib/orb/models/coupon_create_params.rb +3 -3
- data/lib/orb/models/credit_note.rb +33 -33
- data/lib/orb/models/credit_note_create_params.rb +4 -4
- data/lib/orb/models/customer.rb +39 -39
- data/lib/orb/models/customer_create_params.rb +26 -26
- data/lib/orb/models/customer_update_by_external_id_params.rb +26 -26
- data/lib/orb/models/customer_update_params.rb +26 -26
- data/lib/orb/models/customers/balance_transaction_create_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +2 -2
- data/lib/orb/models/customers/cost_list_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_response.rb +2 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +7 -7
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +8 -8
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +4 -4
- data/lib/orb/models/customers/credits/ledger_list_params.rb +4 -4
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +6 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +6 -5
- data/lib/orb/models/dimensional_price_group.rb +1 -1
- data/lib/orb/models/dimensional_price_groups.rb +4 -4
- data/lib/orb/models/discount.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +3 -3
- data/lib/orb/models/events/event_volumes.rb +2 -2
- data/lib/orb/models/invoice.rb +114 -113
- data/lib/orb/models/invoice_create_params.rb +10 -10
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +6 -6
- data/lib/orb/models/invoice_level_discount.rb +1 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +4 -4
- data/lib/orb/models/invoice_list_params.rb +4 -4
- data/lib/orb/models/item.rb +5 -5
- data/lib/orb/models/item_update_params.rb +5 -5
- data/lib/orb/models/percentage_discount.rb +5 -5
- data/lib/orb/models/plan.rb +58 -58
- data/lib/orb/models/plan_create_params.rb +448 -444
- data/lib/orb/models/plan_list_params.rb +2 -2
- data/lib/orb/models/price.rb +1204 -1204
- data/lib/orb/models/price_create_params.rb +50 -50
- data/lib/orb/models/price_evaluate_response.rb +2 -2
- data/lib/orb/models/subscription.rb +58 -56
- data/lib/orb/models/subscription_cancel_params.rb +2 -2
- data/lib/orb/models/subscription_cancel_response.rb +14 -14
- data/lib/orb/models/subscription_change_apply_response.rb +14 -14
- data/lib/orb/models/subscription_change_cancel_response.rb +14 -14
- data/lib/orb/models/subscription_change_retrieve_response.rb +14 -14
- data/lib/orb/models/subscription_create_params.rb +1002 -987
- data/lib/orb/models/subscription_create_response.rb +14 -14
- data/lib/orb/models/subscription_fetch_costs_params.rb +2 -2
- data/lib/orb/models/subscription_fetch_costs_response.rb +2 -2
- data/lib/orb/models/subscription_fetch_usage_params.rb +4 -4
- data/lib/orb/models/subscription_list_params.rb +2 -2
- data/lib/orb/models/subscription_price_intervals_params.rb +596 -585
- data/lib/orb/models/subscription_price_intervals_response.rb +14 -14
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +973 -971
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +14 -14
- data/lib/orb/models/subscription_trigger_phase_response.rb +14 -14
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +14 -14
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +14 -14
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +14 -14
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +2 -2
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +14 -14
- data/lib/orb/models/subscription_update_trial_params.rb +3 -3
- data/lib/orb/models/subscription_update_trial_response.rb +14 -14
- data/lib/orb/models/subscription_usage.rb +26 -26
- data/lib/orb/models/subscriptions.rb +4 -4
- data/lib/orb/models/trial_discount.rb +5 -5
- data/lib/orb/models/usage_discount.rb +5 -5
- data/lib/orb/resources/alerts.rb +15 -15
- data/lib/orb/resources/coupons/subscriptions.rb +1 -1
- data/lib/orb/resources/coupons.rb +5 -5
- data/lib/orb/resources/credit_notes.rb +5 -5
- data/lib/orb/resources/customers/balance_transactions.rb +1 -1
- data/lib/orb/resources/customers/costs.rb +2 -2
- data/lib/orb/resources/customers/credits/ledger.rb +10 -10
- data/lib/orb/resources/customers/credits/top_ups.rb +4 -4
- data/lib/orb/resources/customers.rb +30 -30
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +1 -1
- data/lib/orb/resources/dimensional_price_groups.rb +3 -3
- data/lib/orb/resources/events/volume.rb +1 -1
- data/lib/orb/resources/events.rb +1 -1
- data/lib/orb/resources/invoices.rb +12 -12
- data/lib/orb/resources/items.rb +5 -5
- data/lib/orb/resources/metrics.rb +4 -4
- data/lib/orb/resources/plans/external_plan_id.rb +2 -2
- data/lib/orb/resources/plans.rb +7 -7
- data/lib/orb/resources/prices/external_price_id.rb +2 -2
- data/lib/orb/resources/prices.rb +17 -17
- data/lib/orb/resources/subscriptions.rb +32 -32
- data/lib/orb/version.rb +1 -1
- data/rbi/orb/internal.rbi +3 -0
- data/rbi/orb/models/subscription_price_intervals_params.rbi +26 -72
- data/rbi/orb/models/subscription_update_trial_params.rbi +14 -3
- data/rbi/orb/resources/subscriptions.rbi +4 -1
- data/sig/orb/internal/page.rbs +2 -0
- data/sig/orb/internal.rbs +2 -0
- data/sig/orb/models/alert.rbs +32 -4
- data/sig/orb/models/alert_create_for_customer_params.rbs +9 -0
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +9 -0
- data/sig/orb/models/alert_create_for_subscription_params.rbs +9 -0
- data/sig/orb/models/alert_disable_params.rbs +5 -0
- data/sig/orb/models/alert_enable_params.rbs +5 -0
- data/sig/orb/models/alert_list_params.rbs +13 -0
- data/sig/orb/models/alert_retrieve_params.rbs +2 -0
- data/sig/orb/models/alert_update_params.rbs +7 -0
- data/sig/orb/models/amount_discount.rbs +11 -4
- data/sig/orb/models/billable_metric.rbs +13 -4
- data/sig/orb/models/coupon.rbs +14 -4
- data/sig/orb/models/coupon_archive_params.rbs +2 -0
- data/sig/orb/models/coupon_create_params.rbs +15 -0
- data/sig/orb/models/coupon_fetch_params.rbs +2 -0
- data/sig/orb/models/coupon_list_params.rbs +8 -0
- data/sig/orb/models/coupons/subscription_list_params.rbs +6 -0
- data/sig/orb/models/credit_note.rbs +88 -20
- data/sig/orb/models/credit_note_create_params.rbs +9 -0
- data/sig/orb/models/credit_note_fetch_params.rbs +2 -0
- data/sig/orb/models/credit_note_list_params.rbs +10 -0
- data/sig/orb/models/customer.rbs +86 -16
- data/sig/orb/models/customer_create_params.rbs +79 -8
- data/sig/orb/models/customer_delete_params.rbs +2 -0
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +2 -0
- data/sig/orb/models/customer_fetch_params.rbs +2 -0
- data/sig/orb/models/customer_list_params.rbs +10 -0
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +2 -0
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +2 -0
- data/sig/orb/models/customer_update_by_external_id_params.rbs +78 -8
- data/sig/orb/models/customer_update_params.rbs +78 -8
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +7 -0
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +17 -0
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +10 -0
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +17 -0
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +8 -0
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +20 -0
- data/sig/orb/models/customers/cost_list_params.rbs +8 -0
- data/sig/orb/models/customers/cost_list_response.rbs +20 -0
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +8 -0
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +10 -0
- data/sig/orb/models/customers/credit_list_params.rbs +8 -0
- data/sig/orb/models/customers/credit_list_response.rbs +10 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +23 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +23 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +14 -0
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +14 -0
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +177 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +19 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +19 -0
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +6 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +6 -0
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +18 -0
- data/sig/orb/models/dimensional_price_group.rbs +9 -0
- data/sig/orb/models/dimensional_price_group_create_params.rbs +9 -0
- data/sig/orb/models/dimensional_price_group_list_params.rbs +6 -0
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +2 -0
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +2 -0
- data/sig/orb/models/dimensional_price_groups.rbs +5 -0
- data/sig/orb/models/evaluate_price_group.rbs +10 -4
- data/sig/orb/models/event_deprecate_params.rbs +2 -0
- data/sig/orb/models/event_deprecate_response.rbs +2 -0
- data/sig/orb/models/event_ingest_params.rbs +16 -0
- data/sig/orb/models/event_ingest_response.rbs +15 -0
- data/sig/orb/models/event_search_params.rbs +7 -0
- data/sig/orb/models/event_search_response.rbs +12 -0
- data/sig/orb/models/event_update_params.rbs +9 -0
- data/sig/orb/models/event_update_response.rbs +2 -0
- data/sig/orb/models/events/backfill_close_params.rbs +2 -0
- data/sig/orb/models/events/backfill_close_response.rbs +14 -0
- data/sig/orb/models/events/backfill_create_params.rbs +11 -0
- data/sig/orb/models/events/backfill_create_response.rbs +14 -0
- data/sig/orb/models/events/backfill_fetch_params.rbs +2 -0
- data/sig/orb/models/events/backfill_fetch_response.rbs +14 -0
- data/sig/orb/models/events/backfill_list_params.rbs +6 -0
- data/sig/orb/models/events/backfill_list_response.rbs +14 -0
- data/sig/orb/models/events/backfill_revert_params.rbs +2 -0
- data/sig/orb/models/events/backfill_revert_response.rbs +14 -0
- data/sig/orb/models/events/event_volumes.rbs +8 -0
- data/sig/orb/models/events/volume_list_params.rbs +8 -0
- data/sig/orb/models/invoice.rbs +293 -36
- data/sig/orb/models/invoice_create_params.rbs +30 -4
- data/sig/orb/models/invoice_fetch_params.rbs +2 -0
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +5 -0
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +257 -0
- data/sig/orb/models/invoice_issue_params.rbs +5 -0
- data/sig/orb/models/invoice_line_item_create_params.rbs +10 -0
- data/sig/orb/models/invoice_line_item_create_response.rbs +132 -0
- data/sig/orb/models/invoice_list_params.rbs +27 -4
- data/sig/orb/models/invoice_mark_paid_params.rbs +7 -0
- data/sig/orb/models/invoice_pay_params.rbs +2 -0
- data/sig/orb/models/invoice_update_params.rbs +5 -0
- data/sig/orb/models/invoice_void_params.rbs +2 -0
- data/sig/orb/models/item.rbs +16 -4
- data/sig/orb/models/item_create_params.rbs +2 -0
- data/sig/orb/models/item_fetch_params.rbs +2 -0
- data/sig/orb/models/item_list_params.rbs +6 -0
- data/sig/orb/models/item_update_params.rbs +15 -4
- data/sig/orb/models/metric_create_params.rbs +9 -0
- data/sig/orb/models/metric_fetch_params.rbs +2 -0
- data/sig/orb/models/metric_list_params.rbs +10 -0
- data/sig/orb/models/metric_update_params.rbs +5 -0
- data/sig/orb/models/pagination_metadata.rbs +2 -0
- data/sig/orb/models/percentage_discount.rbs +11 -4
- data/sig/orb/models/plan.rbs +141 -16
- data/sig/orb/models/plan_create_params.rbs +1070 -304
- data/sig/orb/models/plan_fetch_params.rbs +2 -0
- data/sig/orb/models/plan_list_params.rbs +11 -0
- data/sig/orb/models/plan_update_params.rbs +6 -0
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +2 -0
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +6 -0
- data/sig/orb/models/price.rbs +2148 -460
- data/sig/orb/models/price_create_params.rbs +130 -8
- data/sig/orb/models/price_evaluate_params.rbs +10 -0
- data/sig/orb/models/price_evaluate_response.rbs +2 -0
- data/sig/orb/models/price_fetch_params.rbs +2 -0
- data/sig/orb/models/price_list_params.rbs +6 -0
- data/sig/orb/models/price_update_params.rbs +5 -0
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +2 -0
- data/sig/orb/models/prices/external_price_id_update_params.rbs +5 -0
- data/sig/orb/models/subscription.rbs +177 -12
- data/sig/orb/models/subscription_cancel_params.rbs +7 -0
- data/sig/orb/models/subscription_cancel_response.rbs +173 -0
- data/sig/orb/models/subscription_change_apply_params.rbs +6 -0
- data/sig/orb/models/subscription_change_apply_response.rbs +186 -0
- data/sig/orb/models/subscription_change_cancel_params.rbs +2 -0
- data/sig/orb/models/subscription_change_cancel_response.rbs +186 -0
- data/sig/orb/models/subscription_change_retrieve_params.rbs +2 -0
- data/sig/orb/models/subscription_change_retrieve_response.rbs +186 -0
- data/sig/orb/models/subscription_create_params.rbs +2368 -632
- data/sig/orb/models/subscription_create_response.rbs +173 -0
- data/sig/orb/models/subscription_fetch_costs_params.rbs +8 -0
- data/sig/orb/models/subscription_fetch_costs_response.rbs +20 -0
- data/sig/orb/models/subscription_fetch_params.rbs +2 -0
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +10 -0
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +13 -0
- data/sig/orb/models/subscription_fetch_usage_params.rbs +14 -0
- data/sig/orb/models/subscription_list_params.rbs +13 -0
- data/sig/orb/models/subscription_price_intervals_params.rbs +1348 -396
- data/sig/orb/models/subscription_price_intervals_response.rbs +173 -0
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +2363 -632
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +173 -0
- data/sig/orb/models/subscription_trigger_phase_params.rbs +6 -0
- data/sig/orb/models/subscription_trigger_phase_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +173 -0
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +9 -0
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +173 -0
- data/sig/orb/models/subscription_update_params.rbs +9 -0
- data/sig/orb/models/subscription_update_trial_params.rbs +6 -0
- data/sig/orb/models/subscription_update_trial_response.rbs +173 -0
- data/sig/orb/models/subscription_usage.rbs +48 -8
- data/sig/orb/models/subscriptions.rbs +5 -0
- data/sig/orb/models/top_level_ping_params.rbs +2 -0
- data/sig/orb/models/top_level_ping_response.rbs +2 -0
- data/sig/orb/models/trial_discount.rbs +12 -4
- data/sig/orb/models/usage_discount.rbs +11 -4
- data/sig/orb/resources/invoices.rbs +1 -1
- data/sig/orb/resources/plans.rbs +1 -1
- metadata +2 -2
@@ -20,7 +20,7 @@ module Orb
|
|
20
20
|
# The adjustment intervals for this subscription sorted by the start_date of the
|
21
21
|
# adjustment interval.
|
22
22
|
#
|
23
|
-
# @return [Array<Orb::Subscription::AdjustmentInterval>]
|
23
|
+
# @return [Array<Orb::Models::Subscription::AdjustmentInterval>]
|
24
24
|
required :adjustment_intervals,
|
25
25
|
-> {
|
26
26
|
Orb::Internal::Type::ArrayOf[Orb::Subscription::AdjustmentInterval]
|
@@ -36,7 +36,7 @@ module Orb
|
|
36
36
|
|
37
37
|
# @!attribute billing_cycle_anchor_configuration
|
38
38
|
#
|
39
|
-
# @return [Orb::Subscription::BillingCycleAnchorConfiguration]
|
39
|
+
# @return [Orb::Models::Subscription::BillingCycleAnchorConfiguration]
|
40
40
|
required :billing_cycle_anchor_configuration, -> { Orb::Subscription::BillingCycleAnchorConfiguration }
|
41
41
|
|
42
42
|
# @!attribute billing_cycle_day
|
@@ -89,7 +89,7 @@ module Orb
|
|
89
89
|
# your account's timezone. See [Timezone localization](/essentials/timezones) for
|
90
90
|
# information on what this timezone parameter influences within Orb.
|
91
91
|
#
|
92
|
-
# @return [Orb::Customer]
|
92
|
+
# @return [Orb::Models::Customer]
|
93
93
|
required :customer, -> { Orb::Customer }
|
94
94
|
|
95
95
|
# @!attribute default_invoice_memo
|
@@ -102,7 +102,7 @@ module Orb
|
|
102
102
|
# @!attribute discount_intervals
|
103
103
|
# The discount intervals for this subscription sorted by the start_date.
|
104
104
|
#
|
105
|
-
# @return [Array<Orb::Subscription::DiscountInterval::Amount, Orb::Subscription::DiscountInterval::Percentage, Orb::Subscription::DiscountInterval::Usage>]
|
105
|
+
# @return [Array<Orb::Models::Subscription::DiscountInterval::Amount, Orb::Models::Subscription::DiscountInterval::Percentage, Orb::Models::Subscription::DiscountInterval::Usage>]
|
106
106
|
required :discount_intervals,
|
107
107
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Subscription::DiscountInterval] }
|
108
108
|
|
@@ -114,7 +114,7 @@ module Orb
|
|
114
114
|
|
115
115
|
# @!attribute fixed_fee_quantity_schedule
|
116
116
|
#
|
117
|
-
# @return [Array<Orb::Subscription::FixedFeeQuantitySchedule>]
|
117
|
+
# @return [Array<Orb::Models::Subscription::FixedFeeQuantitySchedule>]
|
118
118
|
required :fixed_fee_quantity_schedule,
|
119
119
|
-> { Orb::Internal::Type::ArrayOf[Orb::Subscription::FixedFeeQuantitySchedule] }
|
120
120
|
|
@@ -126,7 +126,7 @@ module Orb
|
|
126
126
|
# @!attribute maximum_intervals
|
127
127
|
# The maximum intervals for this subscription sorted by the start_date.
|
128
128
|
#
|
129
|
-
# @return [Array<Orb::Subscription::MaximumInterval>]
|
129
|
+
# @return [Array<Orb::Models::Subscription::MaximumInterval>]
|
130
130
|
required :maximum_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::MaximumInterval] }
|
131
131
|
|
132
132
|
# @!attribute metadata
|
@@ -141,7 +141,7 @@ module Orb
|
|
141
141
|
# @!attribute minimum_intervals
|
142
142
|
# The minimum intervals for this subscription sorted by the start_date.
|
143
143
|
#
|
144
|
-
# @return [Array<Orb::Subscription::MinimumInterval>]
|
144
|
+
# @return [Array<Orb::Models::Subscription::MinimumInterval>]
|
145
145
|
required :minimum_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::MinimumInterval] }
|
146
146
|
|
147
147
|
# @!attribute net_terms
|
@@ -156,7 +156,7 @@ module Orb
|
|
156
156
|
# @!attribute pending_subscription_change
|
157
157
|
# A pending subscription change if one exists on this subscription.
|
158
158
|
#
|
159
|
-
# @return [Orb::Subscription::PendingSubscriptionChange, nil]
|
159
|
+
# @return [Orb::Models::Subscription::PendingSubscriptionChange, nil]
|
160
160
|
required :pending_subscription_change, -> { Orb::Subscription::PendingSubscriptionChange }, nil?: true
|
161
161
|
|
162
162
|
# @!attribute plan
|
@@ -165,18 +165,18 @@ module Orb
|
|
165
165
|
# subscription. You can see more about how to configure prices in the
|
166
166
|
# [Price resource](/reference/price).
|
167
167
|
#
|
168
|
-
# @return [Orb::Plan]
|
168
|
+
# @return [Orb::Models::Plan]
|
169
169
|
required :plan, -> { Orb::Plan }
|
170
170
|
|
171
171
|
# @!attribute price_intervals
|
172
172
|
# The price intervals for this subscription.
|
173
173
|
#
|
174
|
-
# @return [Array<Orb::Subscription::PriceInterval>]
|
174
|
+
# @return [Array<Orb::Models::Subscription::PriceInterval>]
|
175
175
|
required :price_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::PriceInterval] }
|
176
176
|
|
177
177
|
# @!attribute redeemed_coupon
|
178
178
|
#
|
179
|
-
# @return [Orb::Subscription::RedeemedCoupon, nil]
|
179
|
+
# @return [Orb::Models::Subscription::RedeemedCoupon, nil]
|
180
180
|
required :redeemed_coupon, -> { Orb::Subscription::RedeemedCoupon }, nil?: true
|
181
181
|
|
182
182
|
# @!attribute start_date
|
@@ -187,17 +187,17 @@ module Orb
|
|
187
187
|
|
188
188
|
# @!attribute status
|
189
189
|
#
|
190
|
-
# @return [Symbol, Orb::Subscription::Status]
|
190
|
+
# @return [Symbol, Orb::Models::Subscription::Status]
|
191
191
|
required :status, enum: -> { Orb::Subscription::Status }
|
192
192
|
|
193
193
|
# @!attribute trial_info
|
194
194
|
#
|
195
|
-
# @return [Orb::Subscription::TrialInfo]
|
195
|
+
# @return [Orb::Models::Subscription::TrialInfo]
|
196
196
|
required :trial_info, -> { Orb::Subscription::TrialInfo }
|
197
197
|
|
198
198
|
# @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:)
|
199
|
-
# Some parameter documentations has been truncated, see
|
200
|
-
# more details.
|
199
|
+
# Some parameter documentations has been truncated, see
|
200
|
+
# {Orb::Models::Subscription} for more details.
|
201
201
|
#
|
202
202
|
# A [subscription](/core-concepts#subscription) represents the purchase of a plan
|
203
203
|
# by a customer.
|
@@ -223,11 +223,11 @@ module Orb
|
|
223
223
|
#
|
224
224
|
# @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
|
225
225
|
#
|
226
|
-
# @param adjustment_intervals [Array<Orb::Subscription::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
|
226
|
+
# @param adjustment_intervals [Array<Orb::Models::Subscription::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
|
227
227
|
#
|
228
228
|
# @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
|
229
229
|
#
|
230
|
-
# @param billing_cycle_anchor_configuration [Orb::Subscription::BillingCycleAnchorConfiguration]
|
230
|
+
# @param billing_cycle_anchor_configuration [Orb::Models::Subscription::BillingCycleAnchorConfiguration]
|
231
231
|
#
|
232
232
|
# @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
233
233
|
#
|
@@ -237,39 +237,39 @@ module Orb
|
|
237
237
|
#
|
238
238
|
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
239
239
|
#
|
240
|
-
# @param customer [Orb::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
240
|
+
# @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
241
241
|
#
|
242
242
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
243
243
|
#
|
244
|
-
# @param discount_intervals [Array<Orb::Subscription::DiscountInterval::Amount, Orb::Subscription::DiscountInterval::Percentage, Orb::Subscription::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
|
244
|
+
# @param discount_intervals [Array<Orb::Models::Subscription::DiscountInterval::Amount, Orb::Models::Subscription::DiscountInterval::Percentage, Orb::Models::Subscription::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
|
245
245
|
#
|
246
246
|
# @param end_date [Time, nil] The date Orb stops billing for this subscription.
|
247
247
|
#
|
248
|
-
# @param fixed_fee_quantity_schedule [Array<Orb::Subscription::FixedFeeQuantitySchedule>]
|
248
|
+
# @param fixed_fee_quantity_schedule [Array<Orb::Models::Subscription::FixedFeeQuantitySchedule>]
|
249
249
|
#
|
250
250
|
# @param invoicing_threshold [String, nil]
|
251
251
|
#
|
252
|
-
# @param maximum_intervals [Array<Orb::Subscription::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
|
252
|
+
# @param maximum_intervals [Array<Orb::Models::Subscription::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
|
253
253
|
#
|
254
254
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
255
255
|
#
|
256
|
-
# @param minimum_intervals [Array<Orb::Subscription::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
|
256
|
+
# @param minimum_intervals [Array<Orb::Models::Subscription::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
|
257
257
|
#
|
258
258
|
# @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
|
259
259
|
#
|
260
|
-
# @param pending_subscription_change [Orb::Subscription::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
260
|
+
# @param pending_subscription_change [Orb::Models::Subscription::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
261
261
|
#
|
262
|
-
# @param plan [Orb::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
262
|
+
# @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
263
263
|
#
|
264
|
-
# @param price_intervals [Array<Orb::Subscription::PriceInterval>] The price intervals for this subscription.
|
264
|
+
# @param price_intervals [Array<Orb::Models::Subscription::PriceInterval>] The price intervals for this subscription.
|
265
265
|
#
|
266
|
-
# @param redeemed_coupon [Orb::Subscription::RedeemedCoupon, nil]
|
266
|
+
# @param redeemed_coupon [Orb::Models::Subscription::RedeemedCoupon, nil]
|
267
267
|
#
|
268
268
|
# @param start_date [Time] The date Orb starts billing for this subscription.
|
269
269
|
#
|
270
|
-
# @param status [Symbol, Orb::Subscription::Status]
|
270
|
+
# @param status [Symbol, Orb::Models::Subscription::Status]
|
271
271
|
#
|
272
|
-
# @param trial_info [Orb::Subscription::TrialInfo]
|
272
|
+
# @param trial_info [Orb::Models::Subscription::TrialInfo]
|
273
273
|
|
274
274
|
class AdjustmentInterval < Orb::Internal::Type::BaseModel
|
275
275
|
# @!attribute id
|
@@ -279,7 +279,7 @@ module Orb
|
|
279
279
|
|
280
280
|
# @!attribute adjustment
|
281
281
|
#
|
282
|
-
# @return [Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Subscription::AdjustmentInterval::Adjustment::Maximum]
|
282
|
+
# @return [Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum]
|
283
283
|
required :adjustment, union: -> { Orb::Subscription::AdjustmentInterval::Adjustment }
|
284
284
|
|
285
285
|
# @!attribute applies_to_price_interval_ids
|
@@ -303,7 +303,7 @@ module Orb
|
|
303
303
|
# @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
|
304
304
|
# @param id [String]
|
305
305
|
#
|
306
|
-
# @param adjustment [Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Subscription::AdjustmentInterval::Adjustment::Maximum]
|
306
|
+
# @param adjustment [Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum]
|
307
307
|
#
|
308
308
|
# @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
|
309
309
|
#
|
@@ -311,7 +311,7 @@ module Orb
|
|
311
311
|
#
|
312
312
|
# @param start_date [Time] The start date of the adjustment interval.
|
313
313
|
|
314
|
-
# @see Orb::Subscription::AdjustmentInterval#adjustment
|
314
|
+
# @see Orb::Models::Subscription::AdjustmentInterval#adjustment
|
315
315
|
module Adjustment
|
316
316
|
extend Orb::Internal::Type::Union
|
317
317
|
|
@@ -375,8 +375,8 @@ module Orb
|
|
375
375
|
|
376
376
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
377
377
|
# Some parameter documentations has been truncated, see
|
378
|
-
# {Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount} for
|
379
|
-
# details.
|
378
|
+
# {Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount} for
|
379
|
+
# more details.
|
380
380
|
#
|
381
381
|
# @param id [String]
|
382
382
|
#
|
@@ -438,8 +438,8 @@ module Orb
|
|
438
438
|
|
439
439
|
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
440
440
|
# Some parameter documentations has been truncated, see
|
441
|
-
# {Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount} for
|
442
|
-
# details.
|
441
|
+
# {Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount} for
|
442
|
+
# more details.
|
443
443
|
#
|
444
444
|
# @param id [String]
|
445
445
|
#
|
@@ -501,8 +501,8 @@ module Orb
|
|
501
501
|
|
502
502
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
503
503
|
# Some parameter documentations has been truncated, see
|
504
|
-
# {Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount}
|
505
|
-
# details.
|
504
|
+
# {Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount}
|
505
|
+
# for more details.
|
506
506
|
#
|
507
507
|
# @param id [String]
|
508
508
|
#
|
@@ -570,7 +570,8 @@ module Orb
|
|
570
570
|
|
571
571
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
572
572
|
# Some parameter documentations has been truncated, see
|
573
|
-
# {Orb::Subscription::AdjustmentInterval::Adjustment::Minimum} for more
|
573
|
+
# {Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum} for more
|
574
|
+
# details.
|
574
575
|
#
|
575
576
|
# @param id [String]
|
576
577
|
#
|
@@ -634,7 +635,8 @@ module Orb
|
|
634
635
|
|
635
636
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
636
637
|
# Some parameter documentations has been truncated, see
|
637
|
-
# {Orb::Subscription::AdjustmentInterval::Adjustment::Maximum} for more
|
638
|
+
# {Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum} for more
|
639
|
+
# details.
|
638
640
|
#
|
639
641
|
# @param id [String]
|
640
642
|
#
|
@@ -652,11 +654,11 @@ module Orb
|
|
652
654
|
end
|
653
655
|
|
654
656
|
# @!method self.variants
|
655
|
-
# @return [Array(Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Subscription::AdjustmentInterval::Adjustment::Maximum)]
|
657
|
+
# @return [Array(Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum)]
|
656
658
|
end
|
657
659
|
end
|
658
660
|
|
659
|
-
# @see Orb::Subscription#billing_cycle_anchor_configuration
|
661
|
+
# @see Orb::Models::Subscription#billing_cycle_anchor_configuration
|
660
662
|
class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel
|
661
663
|
# @!attribute day
|
662
664
|
# The day of the month on which the billing cycle is anchored. If the maximum
|
@@ -684,7 +686,7 @@ module Orb
|
|
684
686
|
|
685
687
|
# @!method initialize(day:, month: nil, year: nil)
|
686
688
|
# Some parameter documentations has been truncated, see
|
687
|
-
# {Orb::Subscription::BillingCycleAnchorConfiguration} for more details.
|
689
|
+
# {Orb::Models::Subscription::BillingCycleAnchorConfiguration} for more details.
|
688
690
|
#
|
689
691
|
# @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
690
692
|
#
|
@@ -793,7 +795,7 @@ module Orb
|
|
793
795
|
|
794
796
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
|
795
797
|
# Some parameter documentations has been truncated, see
|
796
|
-
# {Orb::Subscription::DiscountInterval::Percentage} for more details.
|
798
|
+
# {Orb::Models::Subscription::DiscountInterval::Percentage} for more details.
|
797
799
|
#
|
798
800
|
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
799
801
|
#
|
@@ -847,7 +849,7 @@ module Orb
|
|
847
849
|
|
848
850
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
|
849
851
|
# Some parameter documentations has been truncated, see
|
850
|
-
# {Orb::Subscription::DiscountInterval::Usage} for more details.
|
852
|
+
# {Orb::Models::Subscription::DiscountInterval::Usage} for more details.
|
851
853
|
#
|
852
854
|
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
853
855
|
#
|
@@ -863,7 +865,7 @@ module Orb
|
|
863
865
|
end
|
864
866
|
|
865
867
|
# @!method self.variants
|
866
|
-
# @return [Array(Orb::Subscription::DiscountInterval::Amount, Orb::Subscription::DiscountInterval::Percentage, Orb::Subscription::DiscountInterval::Usage)]
|
868
|
+
# @return [Array(Orb::Models::Subscription::DiscountInterval::Amount, Orb::Models::Subscription::DiscountInterval::Percentage, Orb::Models::Subscription::DiscountInterval::Usage)]
|
867
869
|
end
|
868
870
|
|
869
871
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
@@ -928,7 +930,7 @@ module Orb
|
|
928
930
|
|
929
931
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:)
|
930
932
|
# Some parameter documentations has been truncated, see
|
931
|
-
# {Orb::Subscription::MaximumInterval} for more details.
|
933
|
+
# {Orb::Models::Subscription::MaximumInterval} for more details.
|
932
934
|
#
|
933
935
|
# @param applies_to_price_ids [Array<String>] The price ids that this maximum interval applies to.
|
934
936
|
#
|
@@ -975,7 +977,7 @@ module Orb
|
|
975
977
|
|
976
978
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:)
|
977
979
|
# Some parameter documentations has been truncated, see
|
978
|
-
# {Orb::Subscription::MinimumInterval} for more details.
|
980
|
+
# {Orb::Models::Subscription::MinimumInterval} for more details.
|
979
981
|
#
|
980
982
|
# @param applies_to_price_ids [Array<String>] The price ids that this minimum interval applies to.
|
981
983
|
#
|
@@ -988,7 +990,7 @@ module Orb
|
|
988
990
|
# @param start_date [Time] The start date of the minimum interval.
|
989
991
|
end
|
990
992
|
|
991
|
-
# @see Orb::Subscription#pending_subscription_change
|
993
|
+
# @see Orb::Models::Subscription#pending_subscription_change
|
992
994
|
class PendingSubscriptionChange < Orb::Internal::Type::BaseModel
|
993
995
|
# @!attribute id
|
994
996
|
#
|
@@ -1046,7 +1048,7 @@ module Orb
|
|
1046
1048
|
# The fixed fee quantity transitions for this price interval. This is only
|
1047
1049
|
# relevant for fixed fees.
|
1048
1050
|
#
|
1049
|
-
# @return [Array<Orb::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil]
|
1051
|
+
# @return [Array<Orb::Models::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil]
|
1050
1052
|
required :fixed_fee_quantity_transitions,
|
1051
1053
|
-> {
|
1052
1054
|
Orb::Internal::Type::ArrayOf[Orb::Subscription::PriceInterval::FixedFeeQuantityTransition]
|
@@ -1065,7 +1067,7 @@ module Orb
|
|
1065
1067
|
# For more on the types of prices, see
|
1066
1068
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1067
1069
|
#
|
1068
|
-
# @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
|
1070
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
|
1069
1071
|
required :price, union: -> { Orb::Price }
|
1070
1072
|
|
1071
1073
|
# @!attribute start_date
|
@@ -1084,7 +1086,7 @@ module Orb
|
|
1084
1086
|
|
1085
1087
|
# @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:)
|
1086
1088
|
# Some parameter documentations has been truncated, see
|
1087
|
-
# {Orb::Subscription::PriceInterval} for more details.
|
1089
|
+
# {Orb::Models::Subscription::PriceInterval} for more details.
|
1088
1090
|
#
|
1089
1091
|
# The Price Interval resource represents a period of time for which a price will
|
1090
1092
|
# bill on a subscription. A subscription’s price intervals define its billing
|
@@ -1102,9 +1104,9 @@ module Orb
|
|
1102
1104
|
#
|
1103
1105
|
# @param filter [String, nil] An additional filter to apply to usage queries.
|
1104
1106
|
#
|
1105
|
-
# @param fixed_fee_quantity_transitions [Array<Orb::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1107
|
+
# @param fixed_fee_quantity_transitions [Array<Orb::Models::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1106
1108
|
#
|
1107
|
-
# @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
|
1109
|
+
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
|
1108
1110
|
#
|
1109
1111
|
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
1110
1112
|
#
|
@@ -1133,7 +1135,7 @@ module Orb
|
|
1133
1135
|
end
|
1134
1136
|
end
|
1135
1137
|
|
1136
|
-
# @see Orb::Subscription#redeemed_coupon
|
1138
|
+
# @see Orb::Models::Subscription#redeemed_coupon
|
1137
1139
|
class RedeemedCoupon < Orb::Internal::Type::BaseModel
|
1138
1140
|
# @!attribute coupon_id
|
1139
1141
|
#
|
@@ -1156,7 +1158,7 @@ module Orb
|
|
1156
1158
|
# @param start_date [Time]
|
1157
1159
|
end
|
1158
1160
|
|
1159
|
-
# @see Orb::Subscription#status
|
1161
|
+
# @see Orb::Models::Subscription#status
|
1160
1162
|
module Status
|
1161
1163
|
extend Orb::Internal::Type::Enum
|
1162
1164
|
|
@@ -1168,7 +1170,7 @@ module Orb
|
|
1168
1170
|
# @return [Array<Symbol>]
|
1169
1171
|
end
|
1170
1172
|
|
1171
|
-
# @see Orb::Subscription#trial_info
|
1173
|
+
# @see Orb::Models::Subscription#trial_info
|
1172
1174
|
class TrialInfo < Orb::Internal::Type::BaseModel
|
1173
1175
|
# @!attribute end_date
|
1174
1176
|
#
|
@@ -10,7 +10,7 @@ module Orb
|
|
10
10
|
# @!attribute cancel_option
|
11
11
|
# Determines the timing of subscription cancellation
|
12
12
|
#
|
13
|
-
# @return [Symbol, Orb::SubscriptionCancelParams::CancelOption]
|
13
|
+
# @return [Symbol, Orb::Models::SubscriptionCancelParams::CancelOption]
|
14
14
|
required :cancel_option, enum: -> { Orb::SubscriptionCancelParams::CancelOption }
|
15
15
|
|
16
16
|
# @!attribute allow_invoice_credit_or_void
|
@@ -32,7 +32,7 @@ module Orb
|
|
32
32
|
# Some parameter documentations has been truncated, see
|
33
33
|
# {Orb::Models::SubscriptionCancelParams} for more details.
|
34
34
|
#
|
35
|
-
# @param cancel_option [Symbol, Orb::SubscriptionCancelParams::CancelOption] Determines the timing of subscription cancellation
|
35
|
+
# @param cancel_option [Symbol, Orb::Models::SubscriptionCancelParams::CancelOption] Determines the timing of subscription cancellation
|
36
36
|
#
|
37
37
|
# @param allow_invoice_credit_or_void [Boolean, nil] If false, this request will fail if it would void an issued invoice or create a
|
38
38
|
#
|
@@ -88,7 +88,7 @@ module Orb
|
|
88
88
|
# your account's timezone. See [Timezone localization](/essentials/timezones) for
|
89
89
|
# information on what this timezone parameter influences within Orb.
|
90
90
|
#
|
91
|
-
# @return [Orb::Customer]
|
91
|
+
# @return [Orb::Models::Customer]
|
92
92
|
required :customer, -> { Orb::Customer }
|
93
93
|
|
94
94
|
# @!attribute default_invoice_memo
|
@@ -168,7 +168,7 @@ module Orb
|
|
168
168
|
# subscription. You can see more about how to configure prices in the
|
169
169
|
# [Price resource](/reference/price).
|
170
170
|
#
|
171
|
-
# @return [Orb::Plan]
|
171
|
+
# @return [Orb::Models::Plan]
|
172
172
|
required :plan, -> { Orb::Plan }
|
173
173
|
|
174
174
|
# @!attribute price_intervals
|
@@ -229,7 +229,7 @@ module Orb
|
|
229
229
|
#
|
230
230
|
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
231
231
|
#
|
232
|
-
# @param customer [Orb::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
232
|
+
# @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
233
233
|
#
|
234
234
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
235
235
|
#
|
@@ -251,7 +251,7 @@ module Orb
|
|
251
251
|
#
|
252
252
|
# @param pending_subscription_change [Orb::Models::SubscriptionCancelResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
253
253
|
#
|
254
|
-
# @param plan [Orb::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
254
|
+
# @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
255
255
|
#
|
256
256
|
# @param price_intervals [Array<Orb::Models::SubscriptionCancelResponse::PriceInterval>] The price intervals for this subscription.
|
257
257
|
#
|
@@ -1063,7 +1063,7 @@ module Orb
|
|
1063
1063
|
# For more on the types of prices, see
|
1064
1064
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1065
1065
|
#
|
1066
|
-
# @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
|
1066
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
|
1067
1067
|
required :price, union: -> { Orb::Price }
|
1068
1068
|
|
1069
1069
|
# @!attribute start_date
|
@@ -1102,7 +1102,7 @@ module Orb
|
|
1102
1102
|
#
|
1103
1103
|
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionCancelResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1104
1104
|
#
|
1105
|
-
# @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
|
1105
|
+
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
|
1106
1106
|
#
|
1107
1107
|
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
1108
1108
|
#
|
@@ -1182,25 +1182,25 @@ module Orb
|
|
1182
1182
|
# @!attribute created_credit_notes
|
1183
1183
|
# The credit notes that were created as part of this operation.
|
1184
1184
|
#
|
1185
|
-
# @return [Array<Orb::CreditNote>]
|
1185
|
+
# @return [Array<Orb::Models::CreditNote>]
|
1186
1186
|
required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
|
1187
1187
|
|
1188
1188
|
# @!attribute created_invoices
|
1189
1189
|
# The invoices that were created as part of this operation.
|
1190
1190
|
#
|
1191
|
-
# @return [Array<Orb::Invoice>]
|
1191
|
+
# @return [Array<Orb::Models::Invoice>]
|
1192
1192
|
required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
|
1193
1193
|
|
1194
1194
|
# @!attribute voided_credit_notes
|
1195
1195
|
# The credit notes that were voided as part of this operation.
|
1196
1196
|
#
|
1197
|
-
# @return [Array<Orb::CreditNote>]
|
1197
|
+
# @return [Array<Orb::Models::CreditNote>]
|
1198
1198
|
required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
|
1199
1199
|
|
1200
1200
|
# @!attribute voided_invoices
|
1201
1201
|
# The invoices that were voided as part of this operation.
|
1202
1202
|
#
|
1203
|
-
# @return [Array<Orb::Invoice>]
|
1203
|
+
# @return [Array<Orb::Models::Invoice>]
|
1204
1204
|
required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
|
1205
1205
|
|
1206
1206
|
# @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
|
@@ -1208,13 +1208,13 @@ module Orb
|
|
1208
1208
|
# fetched through the subscription changes API or if the
|
1209
1209
|
# `include_changed_resources` parameter was passed in the request.
|
1210
1210
|
#
|
1211
|
-
# @param created_credit_notes [Array<Orb::CreditNote>] The credit notes that were created as part of this operation.
|
1211
|
+
# @param created_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were created as part of this operation.
|
1212
1212
|
#
|
1213
|
-
# @param created_invoices [Array<Orb::Invoice>] The invoices that were created as part of this operation.
|
1213
|
+
# @param created_invoices [Array<Orb::Models::Invoice>] The invoices that were created as part of this operation.
|
1214
1214
|
#
|
1215
|
-
# @param voided_credit_notes [Array<Orb::CreditNote>] The credit notes that were voided as part of this operation.
|
1215
|
+
# @param voided_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were voided as part of this operation.
|
1216
1216
|
#
|
1217
|
-
# @param voided_invoices [Array<Orb::Invoice>] The invoices that were voided as part of this operation.
|
1217
|
+
# @param voided_invoices [Array<Orb::Models::Invoice>] The invoices that were voided as part of this operation.
|
1218
1218
|
end
|
1219
1219
|
end
|
1220
1220
|
end
|
@@ -156,7 +156,7 @@ module Orb
|
|
156
156
|
# your account's timezone. See [Timezone localization](/essentials/timezones) for
|
157
157
|
# information on what this timezone parameter influences within Orb.
|
158
158
|
#
|
159
|
-
# @return [Orb::Customer]
|
159
|
+
# @return [Orb::Models::Customer]
|
160
160
|
required :customer, -> { Orb::Customer }
|
161
161
|
|
162
162
|
# @!attribute default_invoice_memo
|
@@ -236,7 +236,7 @@ module Orb
|
|
236
236
|
# subscription. You can see more about how to configure prices in the
|
237
237
|
# [Price resource](/reference/price).
|
238
238
|
#
|
239
|
-
# @return [Orb::Plan]
|
239
|
+
# @return [Orb::Models::Plan]
|
240
240
|
required :plan, -> { Orb::Plan }
|
241
241
|
|
242
242
|
# @!attribute price_intervals
|
@@ -301,7 +301,7 @@ module Orb
|
|
301
301
|
#
|
302
302
|
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
303
303
|
#
|
304
|
-
# @param customer [Orb::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
304
|
+
# @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
305
305
|
#
|
306
306
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
307
307
|
#
|
@@ -323,7 +323,7 @@ module Orb
|
|
323
323
|
#
|
324
324
|
# @param pending_subscription_change [Orb::Models::SubscriptionChangeApplyResponse::Subscription::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
325
325
|
#
|
326
|
-
# @param plan [Orb::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
326
|
+
# @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
327
327
|
#
|
328
328
|
# @param price_intervals [Array<Orb::Models::SubscriptionChangeApplyResponse::Subscription::PriceInterval>] The price intervals for this subscription.
|
329
329
|
#
|
@@ -1141,7 +1141,7 @@ module Orb
|
|
1141
1141
|
# For more on the types of prices, see
|
1142
1142
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1143
1143
|
#
|
1144
|
-
# @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
|
1144
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
|
1145
1145
|
required :price, union: -> { Orb::Price }
|
1146
1146
|
|
1147
1147
|
# @!attribute start_date
|
@@ -1181,7 +1181,7 @@ module Orb
|
|
1181
1181
|
#
|
1182
1182
|
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionChangeApplyResponse::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1183
1183
|
#
|
1184
|
-
# @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
|
1184
|
+
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
|
1185
1185
|
#
|
1186
1186
|
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
1187
1187
|
#
|
@@ -1261,25 +1261,25 @@ module Orb
|
|
1261
1261
|
# @!attribute created_credit_notes
|
1262
1262
|
# The credit notes that were created as part of this operation.
|
1263
1263
|
#
|
1264
|
-
# @return [Array<Orb::CreditNote>]
|
1264
|
+
# @return [Array<Orb::Models::CreditNote>]
|
1265
1265
|
required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
|
1266
1266
|
|
1267
1267
|
# @!attribute created_invoices
|
1268
1268
|
# The invoices that were created as part of this operation.
|
1269
1269
|
#
|
1270
|
-
# @return [Array<Orb::Invoice>]
|
1270
|
+
# @return [Array<Orb::Models::Invoice>]
|
1271
1271
|
required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
|
1272
1272
|
|
1273
1273
|
# @!attribute voided_credit_notes
|
1274
1274
|
# The credit notes that were voided as part of this operation.
|
1275
1275
|
#
|
1276
|
-
# @return [Array<Orb::CreditNote>]
|
1276
|
+
# @return [Array<Orb::Models::CreditNote>]
|
1277
1277
|
required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
|
1278
1278
|
|
1279
1279
|
# @!attribute voided_invoices
|
1280
1280
|
# The invoices that were voided as part of this operation.
|
1281
1281
|
#
|
1282
|
-
# @return [Array<Orb::Invoice>]
|
1282
|
+
# @return [Array<Orb::Models::Invoice>]
|
1283
1283
|
required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
|
1284
1284
|
|
1285
1285
|
# @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
|
@@ -1287,13 +1287,13 @@ module Orb
|
|
1287
1287
|
# fetched through the subscription changes API or if the
|
1288
1288
|
# `include_changed_resources` parameter was passed in the request.
|
1289
1289
|
#
|
1290
|
-
# @param created_credit_notes [Array<Orb::CreditNote>] The credit notes that were created as part of this operation.
|
1290
|
+
# @param created_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were created as part of this operation.
|
1291
1291
|
#
|
1292
|
-
# @param created_invoices [Array<Orb::Invoice>] The invoices that were created as part of this operation.
|
1292
|
+
# @param created_invoices [Array<Orb::Models::Invoice>] The invoices that were created as part of this operation.
|
1293
1293
|
#
|
1294
|
-
# @param voided_credit_notes [Array<Orb::CreditNote>] The credit notes that were voided as part of this operation.
|
1294
|
+
# @param voided_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were voided as part of this operation.
|
1295
1295
|
#
|
1296
|
-
# @param voided_invoices [Array<Orb::Invoice>] The invoices that were voided as part of this operation.
|
1296
|
+
# @param voided_invoices [Array<Orb::Models::Invoice>] The invoices that were voided as part of this operation.
|
1297
1297
|
end
|
1298
1298
|
end
|
1299
1299
|
end
|