orb-billing 0.3.0 → 0.3.1
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 +33 -0
- data/README.md +5 -5
- data/lib/orb/errors.rb +9 -9
- data/lib/orb/internal/page.rb +3 -3
- data/lib/orb/internal/transport/base_client.rb +3 -3
- data/lib/orb/internal/type/base_model.rb +1 -9
- data/lib/orb/internal/type/boolean.rb +10 -11
- data/lib/orb/internal/type/enum.rb +10 -11
- data/lib/orb/internal/type/request_parameters.rb +2 -8
- data/lib/orb/internal/type/unknown.rb +10 -11
- data/lib/orb/internal/util.rb +20 -4
- data/lib/orb/models/coupon_create_params.rb +7 -7
- data/lib/orb/models/customer_create_params.rb +7 -7
- data/lib/orb/models/customer_update_by_external_id_params.rb +7 -9
- data/lib/orb/models/customer_update_params.rb +7 -7
- data/lib/orb/models/customers/cost_list_by_external_id_response.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_response.rb +106 -107
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +111 -119
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +110 -114
- data/lib/orb/models/customers/credits/ledger_list_response.rb +112 -124
- data/lib/orb/models/invoice.rb +50 -64
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +51 -55
- data/lib/orb/models/invoice_line_item_create_response.rb +54 -57
- data/lib/orb/models/plan.rb +20 -23
- data/lib/orb/models/plan_create_params.rb +635 -670
- data/lib/orb/models/price.rb +1547 -1599
- data/lib/orb/models/subscription.rb +35 -41
- data/lib/orb/models/subscription_cancel_response.rb +33 -36
- data/lib/orb/models/subscription_change_apply_response.rb +31 -32
- data/lib/orb/models/subscription_change_cancel_response.rb +31 -31
- data/lib/orb/models/subscription_change_retrieve_response.rb +31 -31
- data/lib/orb/models/subscription_create_params.rb +1316 -1367
- data/lib/orb/models/subscription_create_response.rb +33 -36
- data/lib/orb/models/subscription_fetch_costs_response.rb +2 -2
- data/lib/orb/models/subscription_price_intervals_params.rb +748 -774
- data/lib/orb/models/subscription_price_intervals_response.rb +32 -35
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1299 -1354
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +31 -33
- data/lib/orb/models/subscription_trigger_phase_response.rb +32 -35
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +31 -33
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +31 -31
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +31 -31
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +31 -33
- data/lib/orb/models/subscription_update_trial_response.rb +33 -36
- data/lib/orb/models.rb +220 -0
- data/lib/orb/request_options.rb +4 -5
- data/lib/orb/resources/coupons.rb +1 -1
- data/lib/orb/resources/customers/credits/ledger.rb +4 -4
- data/lib/orb/resources/customers.rb +3 -3
- data/lib/orb/resources/plans.rb +1 -1
- data/lib/orb/resources/prices/external_price_id.rb +2 -2
- data/lib/orb/resources/prices.rb +4 -4
- data/lib/orb/version.rb +1 -1
- data/rbi/{lib/orb → orb}/errors.rbi +1 -1
- data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +2 -2
- data/rbi/{lib/orb → orb}/internal/type/request_parameters.rbi +1 -1
- data/rbi/{lib/orb → orb}/internal/util.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +9 -9
- data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +9 -9
- data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +9 -9
- data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +9 -9
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_response.rbi +84 -84
- data/rbi/{lib/orb → orb}/models/customers/cost_list_response.rbi +84 -84
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +122 -114
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +114 -216
- data/rbi/{lib/orb/models/customers/credits/ledger_list_response.rbi → orb/models/customers/credits/ledger_list_by_external_id_response.rbi} +114 -114
- data/rbi/{lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi → orb/models/customers/credits/ledger_list_response.rbi} +114 -271
- data/rbi/{lib/orb → orb}/models/invoice.rbi +138 -156
- data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +138 -150
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +138 -162
- data/rbi/{lib/orb → orb}/models/plan.rbi +105 -105
- data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +973 -1734
- data/rbi/{lib/orb → orb}/models/price.rbi +1875 -2267
- data/rbi/{lib/orb → orb}/models/subscription.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_create_params.rbi +1988 -2733
- data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_response.rbi +84 -84
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +1125 -1455
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_params.rbi +1988 -2210
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +118 -118
- data/rbi/orb/models.rbi +220 -0
- data/rbi/{lib/orb → orb}/request_options.rbi +2 -0
- data/rbi/{lib/orb → orb}/resources/alerts.rbi +8 -14
- data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/coupons.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +32 -32
- data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers.rbi +15 -45
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +1 -4
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +3 -10
- data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +5 -18
- data/rbi/{lib/orb → orb}/resources/events/volume.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/events.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/invoices.rbi +9 -34
- data/rbi/{lib/orb → orb}/resources/items.rbi +4 -17
- data/rbi/{lib/orb → orb}/resources/metrics.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +2 -8
- data/rbi/{lib/orb → orb}/resources/plans.rbi +29 -35
- data/rbi/orb/resources/prices/external_price_id.rbi +103 -0
- data/rbi/{lib/orb → orb}/resources/prices.rbi +117 -124
- data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +16 -32
- data/rbi/{lib/orb → orb}/resources/top_level.rbi +1 -4
- data/sig/orb/internal/util.rbs +2 -0
- data/sig/orb/models/coupon_create_params.rbs +9 -10
- data/sig/orb/models/customer_create_params.rbs +9 -10
- data/sig/orb/models/customer_update_by_external_id_params.rbs +9 -10
- data/sig/orb/models/customer_update_params.rbs +9 -10
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +113 -113
- data/sig/orb/models/invoice.rbs +54 -54
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -54
- data/sig/orb/models/invoice_line_item_create_response.rbs +54 -54
- data/sig/orb/models/plan.rbs +21 -21
- data/sig/orb/models/plan_create_params.rbs +653 -653
- data/sig/orb/models/price.rbs +1517 -1521
- data/sig/orb/models/subscription.rbs +34 -34
- data/sig/orb/models/subscription_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_apply_response.rbs +34 -34
- data/sig/orb/models/subscription_change_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_retrieve_response.rbs +34 -34
- data/sig/orb/models/subscription_create_params.rbs +1348 -1348
- data/sig/orb/models/subscription_create_response.rbs +34 -34
- data/sig/orb/models/subscription_price_intervals_params.rbs +767 -769
- data/sig/orb/models/subscription_price_intervals_response.rbs +34 -34
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1348 -1348
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +34 -34
- data/sig/orb/models/subscription_trigger_phase_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +34 -34
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +34 -34
- data/sig/orb/models/subscription_update_trial_response.rbs +34 -34
- data/sig/orb/models.rbs +215 -0
- metadata +226 -223
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
- data/rbi/{lib/orb → orb}/client.rbi +0 -0
- data/rbi/{lib/orb → orb}/file_part.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/page.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/array_of.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/converter.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/enum.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/file_input.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/union.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/unknown.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_retrieve_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/amount_discount.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/billable_metric.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/billing_cycle_relative_date.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/coupon.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/coupon_archive_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/coupon_fetch_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/credit_note.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/credit_note_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/credit_note_fetch_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_delete_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_fetch_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_fetch_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_retrieve_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_groups.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/discount.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_deprecate_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_search_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_search_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_update_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_update_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_close_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +2 -2
- /data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_level_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_pay_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_void_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/pagination_metadata.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_evaluate_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/prices/external_price_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_cancel_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_update_trial_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_usage.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscriptions.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/trial_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/usage_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -101,7 +101,7 @@ module Orb
|
|
101
101
|
# @!attribute discount_intervals
|
102
102
|
# The discount intervals for this subscription sorted by the start_date.
|
103
103
|
#
|
104
|
-
# @return [Array<Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::
|
104
|
+
# @return [Array<Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Usage>]
|
105
105
|
required :discount_intervals,
|
106
106
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval] }
|
107
107
|
|
@@ -245,7 +245,7 @@ module Orb
|
|
245
245
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
246
246
|
# ...
|
247
247
|
#
|
248
|
-
# @param discount_intervals [Array<Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::
|
248
|
+
# @param discount_intervals [Array<Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
|
249
249
|
#
|
250
250
|
# @param end_date [Time, nil] The date Orb stops billing for this subscription.
|
251
251
|
#
|
@@ -289,7 +289,7 @@ module Orb
|
|
289
289
|
|
290
290
|
# @!attribute adjustment
|
291
291
|
#
|
292
|
-
# @return [Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::
|
292
|
+
# @return [Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::Maximum]
|
293
293
|
required :adjustment,
|
294
294
|
union: -> { Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment }
|
295
295
|
|
@@ -314,7 +314,7 @@ module Orb
|
|
314
314
|
# @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
|
315
315
|
# @param id [String]
|
316
316
|
#
|
317
|
-
# @param adjustment [Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::
|
317
|
+
# @param adjustment [Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::Maximum]
|
318
318
|
#
|
319
319
|
# @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
|
320
320
|
#
|
@@ -329,21 +329,21 @@ module Orb
|
|
329
329
|
discriminator :adjustment_type
|
330
330
|
|
331
331
|
variant :usage_discount,
|
332
|
-
-> { Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::
|
332
|
+
-> { Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::UsageDiscount }
|
333
333
|
|
334
334
|
variant :amount_discount,
|
335
|
-
-> { Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::
|
335
|
+
-> { Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::AmountDiscount }
|
336
336
|
|
337
337
|
variant :percentage_discount,
|
338
|
-
-> { Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::
|
338
|
+
-> { Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PercentageDiscount }
|
339
339
|
|
340
340
|
variant :minimum,
|
341
|
-
-> { Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::
|
341
|
+
-> { Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::Minimum }
|
342
342
|
|
343
343
|
variant :maximum,
|
344
|
-
-> { Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::
|
344
|
+
-> { Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::Maximum }
|
345
345
|
|
346
|
-
class
|
346
|
+
class UsageDiscount < Orb::Internal::Type::BaseModel
|
347
347
|
# @!attribute id
|
348
348
|
#
|
349
349
|
# @return [String]
|
@@ -388,7 +388,7 @@ module Orb
|
|
388
388
|
|
389
389
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
390
390
|
# Some parameter documentations has been truncated, see
|
391
|
-
# {Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::
|
391
|
+
# {Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::UsageDiscount}
|
392
392
|
# for more details.
|
393
393
|
#
|
394
394
|
# @param id [String]
|
@@ -408,7 +408,7 @@ module Orb
|
|
408
408
|
# @param adjustment_type [Symbol, :usage_discount]
|
409
409
|
end
|
410
410
|
|
411
|
-
class
|
411
|
+
class AmountDiscount < Orb::Internal::Type::BaseModel
|
412
412
|
# @!attribute id
|
413
413
|
#
|
414
414
|
# @return [String]
|
@@ -453,7 +453,7 @@ module Orb
|
|
453
453
|
|
454
454
|
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
455
455
|
# Some parameter documentations has been truncated, see
|
456
|
-
# {Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::
|
456
|
+
# {Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::AmountDiscount}
|
457
457
|
# for more details.
|
458
458
|
#
|
459
459
|
# @param id [String]
|
@@ -473,7 +473,7 @@ module Orb
|
|
473
473
|
# @param adjustment_type [Symbol, :amount_discount]
|
474
474
|
end
|
475
475
|
|
476
|
-
class
|
476
|
+
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
477
477
|
# @!attribute id
|
478
478
|
#
|
479
479
|
# @return [String]
|
@@ -518,7 +518,7 @@ module Orb
|
|
518
518
|
|
519
519
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
520
520
|
# Some parameter documentations has been truncated, see
|
521
|
-
# {Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::
|
521
|
+
# {Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PercentageDiscount}
|
522
522
|
# for more details.
|
523
523
|
#
|
524
524
|
# @param id [String]
|
@@ -538,7 +538,7 @@ module Orb
|
|
538
538
|
# @param adjustment_type [Symbol, :percentage_discount]
|
539
539
|
end
|
540
540
|
|
541
|
-
class
|
541
|
+
class Minimum < Orb::Internal::Type::BaseModel
|
542
542
|
# @!attribute id
|
543
543
|
#
|
544
544
|
# @return [String]
|
@@ -589,7 +589,7 @@ module Orb
|
|
589
589
|
|
590
590
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
591
591
|
# Some parameter documentations has been truncated, see
|
592
|
-
# {Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::
|
592
|
+
# {Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::Minimum}
|
593
593
|
# for more details.
|
594
594
|
#
|
595
595
|
# @param id [String]
|
@@ -611,7 +611,7 @@ module Orb
|
|
611
611
|
# @param adjustment_type [Symbol, :minimum]
|
612
612
|
end
|
613
613
|
|
614
|
-
class
|
614
|
+
class Maximum < Orb::Internal::Type::BaseModel
|
615
615
|
# @!attribute id
|
616
616
|
#
|
617
617
|
# @return [String]
|
@@ -656,7 +656,7 @@ module Orb
|
|
656
656
|
|
657
657
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
658
658
|
# Some parameter documentations has been truncated, see
|
659
|
-
# {Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::
|
659
|
+
# {Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::Maximum}
|
660
660
|
# for more details.
|
661
661
|
#
|
662
662
|
# @param id [String]
|
@@ -677,7 +677,7 @@ module Orb
|
|
677
677
|
end
|
678
678
|
|
679
679
|
# @!method self.variants
|
680
|
-
# @return [Array(Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::
|
680
|
+
# @return [Array(Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::Maximum)]
|
681
681
|
end
|
682
682
|
end
|
683
683
|
|
@@ -727,16 +727,14 @@ module Orb
|
|
727
727
|
|
728
728
|
discriminator :discount_type
|
729
729
|
|
730
|
-
variant :amount,
|
731
|
-
-> { Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::AmountDiscountInterval }
|
730
|
+
variant :amount, -> { Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Amount }
|
732
731
|
|
733
732
|
variant :percentage,
|
734
|
-
-> { Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::
|
733
|
+
-> { Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Percentage }
|
735
734
|
|
736
|
-
variant :usage,
|
737
|
-
-> { Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::UsageDiscountInterval }
|
735
|
+
variant :usage, -> { Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Usage }
|
738
736
|
|
739
|
-
class
|
737
|
+
class Amount < Orb::Internal::Type::BaseModel
|
740
738
|
# @!attribute amount_discount
|
741
739
|
# Only available if discount_type is `amount`.
|
742
740
|
#
|
@@ -786,7 +784,7 @@ module Orb
|
|
786
784
|
# @param discount_type [Symbol, :amount]
|
787
785
|
end
|
788
786
|
|
789
|
-
class
|
787
|
+
class Percentage < Orb::Internal::Type::BaseModel
|
790
788
|
# @!attribute applies_to_price_ids
|
791
789
|
# The price ids that this discount interval applies to.
|
792
790
|
#
|
@@ -825,7 +823,7 @@ module Orb
|
|
825
823
|
|
826
824
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
|
827
825
|
# Some parameter documentations has been truncated, see
|
828
|
-
# {Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::
|
826
|
+
# {Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Percentage}
|
829
827
|
# for more details.
|
830
828
|
#
|
831
829
|
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
@@ -842,7 +840,7 @@ module Orb
|
|
842
840
|
# @param discount_type [Symbol, :percentage]
|
843
841
|
end
|
844
842
|
|
845
|
-
class
|
843
|
+
class Usage < Orb::Internal::Type::BaseModel
|
846
844
|
# @!attribute applies_to_price_ids
|
847
845
|
# The price ids that this discount interval applies to.
|
848
846
|
#
|
@@ -881,7 +879,7 @@ module Orb
|
|
881
879
|
|
882
880
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
|
883
881
|
# Some parameter documentations has been truncated, see
|
884
|
-
# {Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::
|
882
|
+
# {Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Usage}
|
885
883
|
# for more details.
|
886
884
|
#
|
887
885
|
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
@@ -899,7 +897,7 @@ module Orb
|
|
899
897
|
end
|
900
898
|
|
901
899
|
# @!method self.variants
|
902
|
-
# @return [Array(Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::
|
900
|
+
# @return [Array(Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Usage)]
|
903
901
|
end
|
904
902
|
|
905
903
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
@@ -1103,7 +1101,7 @@ module Orb
|
|
1103
1101
|
# For more on the types of prices, see
|
1104
1102
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1105
1103
|
#
|
1106
|
-
# @return [Orb::Models::Price::
|
1104
|
+
# @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]
|
1107
1105
|
required :price, union: -> { Orb::Models::Price }
|
1108
1106
|
|
1109
1107
|
# @!attribute start_date
|
@@ -1147,7 +1145,7 @@ module Orb
|
|
1147
1145
|
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionUnscheduleCancellationResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1148
1146
|
# ...
|
1149
1147
|
#
|
1150
|
-
# @param price [Orb::Models::Price::
|
1148
|
+
# @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
|
1151
1149
|
# ...
|
1152
1150
|
#
|
1153
1151
|
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
@@ -101,7 +101,7 @@ module Orb
|
|
101
101
|
# @!attribute discount_intervals
|
102
102
|
# The discount intervals for this subscription sorted by the start_date.
|
103
103
|
#
|
104
|
-
# @return [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::
|
104
|
+
# @return [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage>]
|
105
105
|
required :discount_intervals,
|
106
106
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval] }
|
107
107
|
|
@@ -246,7 +246,7 @@ module Orb
|
|
246
246
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
247
247
|
# ...
|
248
248
|
#
|
249
|
-
# @param discount_intervals [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::
|
249
|
+
# @param discount_intervals [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
|
250
250
|
#
|
251
251
|
# @param end_date [Time, nil] The date Orb stops billing for this subscription.
|
252
252
|
#
|
@@ -290,7 +290,7 @@ module Orb
|
|
290
290
|
|
291
291
|
# @!attribute adjustment
|
292
292
|
#
|
293
|
-
# @return [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::
|
293
|
+
# @return [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum]
|
294
294
|
required :adjustment,
|
295
295
|
union: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment }
|
296
296
|
|
@@ -315,7 +315,7 @@ module Orb
|
|
315
315
|
# @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
|
316
316
|
# @param id [String]
|
317
317
|
#
|
318
|
-
# @param adjustment [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::
|
318
|
+
# @param adjustment [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum]
|
319
319
|
#
|
320
320
|
# @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
|
321
321
|
#
|
@@ -330,21 +330,21 @@ module Orb
|
|
330
330
|
discriminator :adjustment_type
|
331
331
|
|
332
332
|
variant :usage_discount,
|
333
|
-
-> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::
|
333
|
+
-> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount }
|
334
334
|
|
335
335
|
variant :amount_discount,
|
336
|
-
-> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::
|
336
|
+
-> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount }
|
337
337
|
|
338
338
|
variant :percentage_discount,
|
339
|
-
-> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::
|
339
|
+
-> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount }
|
340
340
|
|
341
341
|
variant :minimum,
|
342
|
-
-> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::
|
342
|
+
-> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum }
|
343
343
|
|
344
344
|
variant :maximum,
|
345
|
-
-> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::
|
345
|
+
-> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum }
|
346
346
|
|
347
|
-
class
|
347
|
+
class UsageDiscount < Orb::Internal::Type::BaseModel
|
348
348
|
# @!attribute id
|
349
349
|
#
|
350
350
|
# @return [String]
|
@@ -389,7 +389,7 @@ module Orb
|
|
389
389
|
|
390
390
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
391
391
|
# Some parameter documentations has been truncated, see
|
392
|
-
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::
|
392
|
+
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount}
|
393
393
|
# for more details.
|
394
394
|
#
|
395
395
|
# @param id [String]
|
@@ -409,7 +409,7 @@ module Orb
|
|
409
409
|
# @param adjustment_type [Symbol, :usage_discount]
|
410
410
|
end
|
411
411
|
|
412
|
-
class
|
412
|
+
class AmountDiscount < Orb::Internal::Type::BaseModel
|
413
413
|
# @!attribute id
|
414
414
|
#
|
415
415
|
# @return [String]
|
@@ -454,7 +454,7 @@ module Orb
|
|
454
454
|
|
455
455
|
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
456
456
|
# Some parameter documentations has been truncated, see
|
457
|
-
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::
|
457
|
+
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount}
|
458
458
|
# for more details.
|
459
459
|
#
|
460
460
|
# @param id [String]
|
@@ -474,7 +474,7 @@ module Orb
|
|
474
474
|
# @param adjustment_type [Symbol, :amount_discount]
|
475
475
|
end
|
476
476
|
|
477
|
-
class
|
477
|
+
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
478
478
|
# @!attribute id
|
479
479
|
#
|
480
480
|
# @return [String]
|
@@ -519,7 +519,7 @@ module Orb
|
|
519
519
|
|
520
520
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
521
521
|
# Some parameter documentations has been truncated, see
|
522
|
-
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::
|
522
|
+
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount}
|
523
523
|
# for more details.
|
524
524
|
#
|
525
525
|
# @param id [String]
|
@@ -539,7 +539,7 @@ module Orb
|
|
539
539
|
# @param adjustment_type [Symbol, :percentage_discount]
|
540
540
|
end
|
541
541
|
|
542
|
-
class
|
542
|
+
class Minimum < Orb::Internal::Type::BaseModel
|
543
543
|
# @!attribute id
|
544
544
|
#
|
545
545
|
# @return [String]
|
@@ -590,7 +590,7 @@ module Orb
|
|
590
590
|
|
591
591
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
592
592
|
# Some parameter documentations has been truncated, see
|
593
|
-
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::
|
593
|
+
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum}
|
594
594
|
# for more details.
|
595
595
|
#
|
596
596
|
# @param id [String]
|
@@ -612,7 +612,7 @@ module Orb
|
|
612
612
|
# @param adjustment_type [Symbol, :minimum]
|
613
613
|
end
|
614
614
|
|
615
|
-
class
|
615
|
+
class Maximum < Orb::Internal::Type::BaseModel
|
616
616
|
# @!attribute id
|
617
617
|
#
|
618
618
|
# @return [String]
|
@@ -657,7 +657,7 @@ module Orb
|
|
657
657
|
|
658
658
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
659
659
|
# Some parameter documentations has been truncated, see
|
660
|
-
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::
|
660
|
+
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum}
|
661
661
|
# for more details.
|
662
662
|
#
|
663
663
|
# @param id [String]
|
@@ -678,7 +678,7 @@ module Orb
|
|
678
678
|
end
|
679
679
|
|
680
680
|
# @!method self.variants
|
681
|
-
# @return [Array(Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::
|
681
|
+
# @return [Array(Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum)]
|
682
682
|
end
|
683
683
|
end
|
684
684
|
|
@@ -729,15 +729,15 @@ module Orb
|
|
729
729
|
discriminator :discount_type
|
730
730
|
|
731
731
|
variant :amount,
|
732
|
-
-> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::
|
732
|
+
-> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount }
|
733
733
|
|
734
734
|
variant :percentage,
|
735
|
-
-> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::
|
735
|
+
-> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage }
|
736
736
|
|
737
737
|
variant :usage,
|
738
|
-
-> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::
|
738
|
+
-> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage }
|
739
739
|
|
740
|
-
class
|
740
|
+
class Amount < Orb::Internal::Type::BaseModel
|
741
741
|
# @!attribute amount_discount
|
742
742
|
# Only available if discount_type is `amount`.
|
743
743
|
#
|
@@ -787,7 +787,7 @@ module Orb
|
|
787
787
|
# @param discount_type [Symbol, :amount]
|
788
788
|
end
|
789
789
|
|
790
|
-
class
|
790
|
+
class Percentage < Orb::Internal::Type::BaseModel
|
791
791
|
# @!attribute applies_to_price_ids
|
792
792
|
# The price ids that this discount interval applies to.
|
793
793
|
#
|
@@ -826,7 +826,7 @@ module Orb
|
|
826
826
|
|
827
827
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
|
828
828
|
# Some parameter documentations has been truncated, see
|
829
|
-
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::
|
829
|
+
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage}
|
830
830
|
# for more details.
|
831
831
|
#
|
832
832
|
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
@@ -843,7 +843,7 @@ module Orb
|
|
843
843
|
# @param discount_type [Symbol, :percentage]
|
844
844
|
end
|
845
845
|
|
846
|
-
class
|
846
|
+
class Usage < Orb::Internal::Type::BaseModel
|
847
847
|
# @!attribute applies_to_price_ids
|
848
848
|
# The price ids that this discount interval applies to.
|
849
849
|
#
|
@@ -882,7 +882,7 @@ module Orb
|
|
882
882
|
|
883
883
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
|
884
884
|
# Some parameter documentations has been truncated, see
|
885
|
-
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::
|
885
|
+
# {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage}
|
886
886
|
# for more details.
|
887
887
|
#
|
888
888
|
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
@@ -900,7 +900,7 @@ module Orb
|
|
900
900
|
end
|
901
901
|
|
902
902
|
# @!method self.variants
|
903
|
-
# @return [Array(Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::
|
903
|
+
# @return [Array(Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage)]
|
904
904
|
end
|
905
905
|
|
906
906
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
@@ -1108,7 +1108,7 @@ module Orb
|
|
1108
1108
|
# For more on the types of prices, see
|
1109
1109
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1110
1110
|
#
|
1111
|
-
# @return [Orb::Models::Price::
|
1111
|
+
# @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]
|
1112
1112
|
required :price, union: -> { Orb::Models::Price }
|
1113
1113
|
|
1114
1114
|
# @!attribute start_date
|
@@ -1152,7 +1152,7 @@ module Orb
|
|
1152
1152
|
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1153
1153
|
# ...
|
1154
1154
|
#
|
1155
|
-
# @param price [Orb::Models::Price::
|
1155
|
+
# @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
|
1156
1156
|
# ...
|
1157
1157
|
#
|
1158
1158
|
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|