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
@@ -170,7 +170,7 @@ module Orb
|
|
170
170
|
# @!attribute discount_intervals
|
171
171
|
# The discount intervals for this subscription sorted by the start_date.
|
172
172
|
#
|
173
|
-
# @return [Array<Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::
|
173
|
+
# @return [Array<Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Amount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Percentage, Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Usage>]
|
174
174
|
required :discount_intervals,
|
175
175
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval] }
|
176
176
|
|
@@ -314,7 +314,7 @@ module Orb
|
|
314
314
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
315
315
|
# ...
|
316
316
|
#
|
317
|
-
# @param discount_intervals [Array<Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::
|
317
|
+
# @param discount_intervals [Array<Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Amount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Percentage, Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
|
318
318
|
#
|
319
319
|
# @param end_date [Time, nil] The date Orb stops billing for this subscription.
|
320
320
|
#
|
@@ -358,7 +358,7 @@ module Orb
|
|
358
358
|
|
359
359
|
# @!attribute adjustment
|
360
360
|
#
|
361
|
-
# @return [Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::
|
361
|
+
# @return [Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::Maximum]
|
362
362
|
required :adjustment,
|
363
363
|
union: -> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment }
|
364
364
|
|
@@ -383,7 +383,7 @@ module Orb
|
|
383
383
|
# @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
|
384
384
|
# @param id [String]
|
385
385
|
#
|
386
|
-
# @param adjustment [Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::
|
386
|
+
# @param adjustment [Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::Maximum]
|
387
387
|
#
|
388
388
|
# @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
|
389
389
|
#
|
@@ -398,21 +398,21 @@ module Orb
|
|
398
398
|
discriminator :adjustment_type
|
399
399
|
|
400
400
|
variant :usage_discount,
|
401
|
-
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::
|
401
|
+
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount }
|
402
402
|
|
403
403
|
variant :amount_discount,
|
404
|
-
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::
|
404
|
+
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount }
|
405
405
|
|
406
406
|
variant :percentage_discount,
|
407
|
-
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::
|
407
|
+
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount }
|
408
408
|
|
409
409
|
variant :minimum,
|
410
|
-
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::
|
410
|
+
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::Minimum }
|
411
411
|
|
412
412
|
variant :maximum,
|
413
|
-
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::
|
413
|
+
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::Maximum }
|
414
414
|
|
415
|
-
class
|
415
|
+
class UsageDiscount < Orb::Internal::Type::BaseModel
|
416
416
|
# @!attribute id
|
417
417
|
#
|
418
418
|
# @return [String]
|
@@ -457,7 +457,7 @@ module Orb
|
|
457
457
|
|
458
458
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
459
459
|
# Some parameter documentations has been truncated, see
|
460
|
-
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::
|
460
|
+
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount}
|
461
461
|
# for more details.
|
462
462
|
#
|
463
463
|
# @param id [String]
|
@@ -477,7 +477,7 @@ module Orb
|
|
477
477
|
# @param adjustment_type [Symbol, :usage_discount]
|
478
478
|
end
|
479
479
|
|
480
|
-
class
|
480
|
+
class AmountDiscount < Orb::Internal::Type::BaseModel
|
481
481
|
# @!attribute id
|
482
482
|
#
|
483
483
|
# @return [String]
|
@@ -522,7 +522,7 @@ module Orb
|
|
522
522
|
|
523
523
|
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
524
524
|
# Some parameter documentations has been truncated, see
|
525
|
-
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::
|
525
|
+
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount}
|
526
526
|
# for more details.
|
527
527
|
#
|
528
528
|
# @param id [String]
|
@@ -542,7 +542,7 @@ module Orb
|
|
542
542
|
# @param adjustment_type [Symbol, :amount_discount]
|
543
543
|
end
|
544
544
|
|
545
|
-
class
|
545
|
+
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
546
546
|
# @!attribute id
|
547
547
|
#
|
548
548
|
# @return [String]
|
@@ -587,7 +587,7 @@ module Orb
|
|
587
587
|
|
588
588
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
589
589
|
# Some parameter documentations has been truncated, see
|
590
|
-
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::
|
590
|
+
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount}
|
591
591
|
# for more details.
|
592
592
|
#
|
593
593
|
# @param id [String]
|
@@ -607,7 +607,7 @@ module Orb
|
|
607
607
|
# @param adjustment_type [Symbol, :percentage_discount]
|
608
608
|
end
|
609
609
|
|
610
|
-
class
|
610
|
+
class Minimum < Orb::Internal::Type::BaseModel
|
611
611
|
# @!attribute id
|
612
612
|
#
|
613
613
|
# @return [String]
|
@@ -658,7 +658,7 @@ module Orb
|
|
658
658
|
|
659
659
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
660
660
|
# Some parameter documentations has been truncated, see
|
661
|
-
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::
|
661
|
+
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::Minimum}
|
662
662
|
# for more details.
|
663
663
|
#
|
664
664
|
# @param id [String]
|
@@ -680,7 +680,7 @@ module Orb
|
|
680
680
|
# @param adjustment_type [Symbol, :minimum]
|
681
681
|
end
|
682
682
|
|
683
|
-
class
|
683
|
+
class Maximum < Orb::Internal::Type::BaseModel
|
684
684
|
# @!attribute id
|
685
685
|
#
|
686
686
|
# @return [String]
|
@@ -725,7 +725,7 @@ module Orb
|
|
725
725
|
|
726
726
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
727
727
|
# Some parameter documentations has been truncated, see
|
728
|
-
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::
|
728
|
+
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::Maximum}
|
729
729
|
# for more details.
|
730
730
|
#
|
731
731
|
# @param id [String]
|
@@ -746,7 +746,7 @@ module Orb
|
|
746
746
|
end
|
747
747
|
|
748
748
|
# @!method self.variants
|
749
|
-
# @return [Array(Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::
|
749
|
+
# @return [Array(Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::Maximum)]
|
750
750
|
end
|
751
751
|
end
|
752
752
|
|
@@ -797,15 +797,14 @@ module Orb
|
|
797
797
|
discriminator :discount_type
|
798
798
|
|
799
799
|
variant :amount,
|
800
|
-
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::
|
800
|
+
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Amount }
|
801
801
|
|
802
802
|
variant :percentage,
|
803
|
-
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::
|
803
|
+
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Percentage }
|
804
804
|
|
805
|
-
variant :usage,
|
806
|
-
-> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::UsageDiscountInterval }
|
805
|
+
variant :usage, -> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Usage }
|
807
806
|
|
808
|
-
class
|
807
|
+
class Amount < Orb::Internal::Type::BaseModel
|
809
808
|
# @!attribute amount_discount
|
810
809
|
# Only available if discount_type is `amount`.
|
811
810
|
#
|
@@ -855,7 +854,7 @@ module Orb
|
|
855
854
|
# @param discount_type [Symbol, :amount]
|
856
855
|
end
|
857
856
|
|
858
|
-
class
|
857
|
+
class Percentage < Orb::Internal::Type::BaseModel
|
859
858
|
# @!attribute applies_to_price_ids
|
860
859
|
# The price ids that this discount interval applies to.
|
861
860
|
#
|
@@ -894,7 +893,7 @@ module Orb
|
|
894
893
|
|
895
894
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
|
896
895
|
# Some parameter documentations has been truncated, see
|
897
|
-
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::
|
896
|
+
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Percentage}
|
898
897
|
# for more details.
|
899
898
|
#
|
900
899
|
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
@@ -911,7 +910,7 @@ module Orb
|
|
911
910
|
# @param discount_type [Symbol, :percentage]
|
912
911
|
end
|
913
912
|
|
914
|
-
class
|
913
|
+
class Usage < Orb::Internal::Type::BaseModel
|
915
914
|
# @!attribute applies_to_price_ids
|
916
915
|
# The price ids that this discount interval applies to.
|
917
916
|
#
|
@@ -950,7 +949,7 @@ module Orb
|
|
950
949
|
|
951
950
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
|
952
951
|
# Some parameter documentations has been truncated, see
|
953
|
-
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::
|
952
|
+
# {Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Usage}
|
954
953
|
# for more details.
|
955
954
|
#
|
956
955
|
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
@@ -968,7 +967,7 @@ module Orb
|
|
968
967
|
end
|
969
968
|
|
970
969
|
# @!method self.variants
|
971
|
-
# @return [Array(Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::
|
970
|
+
# @return [Array(Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Amount, Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Percentage, Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::Usage)]
|
972
971
|
end
|
973
972
|
|
974
973
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
@@ -1172,7 +1171,7 @@ module Orb
|
|
1172
1171
|
# For more on the types of prices, see
|
1173
1172
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1174
1173
|
#
|
1175
|
-
# @return [Orb::Models::Price::
|
1174
|
+
# @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]
|
1176
1175
|
required :price, union: -> { Orb::Models::Price }
|
1177
1176
|
|
1178
1177
|
# @!attribute start_date
|
@@ -1216,7 +1215,7 @@ module Orb
|
|
1216
1215
|
# @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
|
1217
1216
|
# ...
|
1218
1217
|
#
|
1219
|
-
# @param price [Orb::Models::Price::
|
1218
|
+
# @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
|
1220
1219
|
# ...
|
1221
1220
|
#
|
1222
1221
|
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
@@ -170,7 +170,7 @@ module Orb
|
|
170
170
|
# @!attribute discount_intervals
|
171
171
|
# The discount intervals for this subscription sorted by the start_date.
|
172
172
|
#
|
173
|
-
# @return [Array<Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::
|
173
|
+
# @return [Array<Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Amount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Percentage, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Usage>]
|
174
174
|
required :discount_intervals,
|
175
175
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval] }
|
176
176
|
|
@@ -314,7 +314,7 @@ module Orb
|
|
314
314
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
315
315
|
# ...
|
316
316
|
#
|
317
|
-
# @param discount_intervals [Array<Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::
|
317
|
+
# @param discount_intervals [Array<Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Amount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Percentage, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
|
318
318
|
#
|
319
319
|
# @param end_date [Time, nil] The date Orb stops billing for this subscription.
|
320
320
|
#
|
@@ -358,7 +358,7 @@ module Orb
|
|
358
358
|
|
359
359
|
# @!attribute adjustment
|
360
360
|
#
|
361
|
-
# @return [Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::
|
361
|
+
# @return [Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Maximum]
|
362
362
|
required :adjustment,
|
363
363
|
union: -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment }
|
364
364
|
|
@@ -383,7 +383,7 @@ module Orb
|
|
383
383
|
# @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
|
384
384
|
# @param id [String]
|
385
385
|
#
|
386
|
-
# @param adjustment [Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::
|
386
|
+
# @param adjustment [Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Maximum]
|
387
387
|
#
|
388
388
|
# @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
|
389
389
|
#
|
@@ -398,21 +398,21 @@ module Orb
|
|
398
398
|
discriminator :adjustment_type
|
399
399
|
|
400
400
|
variant :usage_discount,
|
401
|
-
-> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::
|
401
|
+
-> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount }
|
402
402
|
|
403
403
|
variant :amount_discount,
|
404
|
-
-> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::
|
404
|
+
-> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount }
|
405
405
|
|
406
406
|
variant :percentage_discount,
|
407
|
-
-> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::
|
407
|
+
-> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount }
|
408
408
|
|
409
409
|
variant :minimum,
|
410
|
-
-> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::
|
410
|
+
-> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Minimum }
|
411
411
|
|
412
412
|
variant :maximum,
|
413
|
-
-> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::
|
413
|
+
-> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Maximum }
|
414
414
|
|
415
|
-
class
|
415
|
+
class UsageDiscount < Orb::Internal::Type::BaseModel
|
416
416
|
# @!attribute id
|
417
417
|
#
|
418
418
|
# @return [String]
|
@@ -457,7 +457,7 @@ module Orb
|
|
457
457
|
|
458
458
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
459
459
|
# Some parameter documentations has been truncated, see
|
460
|
-
# {Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::
|
460
|
+
# {Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount}
|
461
461
|
# for more details.
|
462
462
|
#
|
463
463
|
# @param id [String]
|
@@ -477,7 +477,7 @@ module Orb
|
|
477
477
|
# @param adjustment_type [Symbol, :usage_discount]
|
478
478
|
end
|
479
479
|
|
480
|
-
class
|
480
|
+
class AmountDiscount < Orb::Internal::Type::BaseModel
|
481
481
|
# @!attribute id
|
482
482
|
#
|
483
483
|
# @return [String]
|
@@ -522,7 +522,7 @@ module Orb
|
|
522
522
|
|
523
523
|
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
524
524
|
# Some parameter documentations has been truncated, see
|
525
|
-
# {Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::
|
525
|
+
# {Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount}
|
526
526
|
# for more details.
|
527
527
|
#
|
528
528
|
# @param id [String]
|
@@ -542,7 +542,7 @@ module Orb
|
|
542
542
|
# @param adjustment_type [Symbol, :amount_discount]
|
543
543
|
end
|
544
544
|
|
545
|
-
class
|
545
|
+
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
546
546
|
# @!attribute id
|
547
547
|
#
|
548
548
|
# @return [String]
|
@@ -587,7 +587,7 @@ module Orb
|
|
587
587
|
|
588
588
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
589
589
|
# Some parameter documentations has been truncated, see
|
590
|
-
# {Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::
|
590
|
+
# {Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount}
|
591
591
|
# for more details.
|
592
592
|
#
|
593
593
|
# @param id [String]
|
@@ -607,7 +607,7 @@ module Orb
|
|
607
607
|
# @param adjustment_type [Symbol, :percentage_discount]
|
608
608
|
end
|
609
609
|
|
610
|
-
class
|
610
|
+
class Minimum < Orb::Internal::Type::BaseModel
|
611
611
|
# @!attribute id
|
612
612
|
#
|
613
613
|
# @return [String]
|
@@ -658,7 +658,7 @@ module Orb
|
|
658
658
|
|
659
659
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
660
660
|
# Some parameter documentations has been truncated, see
|
661
|
-
# {Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::
|
661
|
+
# {Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Minimum}
|
662
662
|
# for more details.
|
663
663
|
#
|
664
664
|
# @param id [String]
|
@@ -680,7 +680,7 @@ module Orb
|
|
680
680
|
# @param adjustment_type [Symbol, :minimum]
|
681
681
|
end
|
682
682
|
|
683
|
-
class
|
683
|
+
class Maximum < Orb::Internal::Type::BaseModel
|
684
684
|
# @!attribute id
|
685
685
|
#
|
686
686
|
# @return [String]
|
@@ -725,7 +725,7 @@ module Orb
|
|
725
725
|
|
726
726
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
727
727
|
# Some parameter documentations has been truncated, see
|
728
|
-
# {Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::
|
728
|
+
# {Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Maximum}
|
729
729
|
# for more details.
|
730
730
|
#
|
731
731
|
# @param id [String]
|
@@ -746,7 +746,7 @@ module Orb
|
|
746
746
|
end
|
747
747
|
|
748
748
|
# @!method self.variants
|
749
|
-
# @return [Array(Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::
|
749
|
+
# @return [Array(Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Maximum)]
|
750
750
|
end
|
751
751
|
end
|
752
752
|
|
@@ -797,15 +797,15 @@ module Orb
|
|
797
797
|
discriminator :discount_type
|
798
798
|
|
799
799
|
variant :amount,
|
800
|
-
-> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::
|
800
|
+
-> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Amount }
|
801
801
|
|
802
802
|
variant :percentage,
|
803
|
-
-> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::
|
803
|
+
-> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Percentage }
|
804
804
|
|
805
805
|
variant :usage,
|
806
|
-
-> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::
|
806
|
+
-> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Usage }
|
807
807
|
|
808
|
-
class
|
808
|
+
class Amount < Orb::Internal::Type::BaseModel
|
809
809
|
# @!attribute amount_discount
|
810
810
|
# Only available if discount_type is `amount`.
|
811
811
|
#
|
@@ -855,7 +855,7 @@ module Orb
|
|
855
855
|
# @param discount_type [Symbol, :amount]
|
856
856
|
end
|
857
857
|
|
858
|
-
class
|
858
|
+
class Percentage < Orb::Internal::Type::BaseModel
|
859
859
|
# @!attribute applies_to_price_ids
|
860
860
|
# The price ids that this discount interval applies to.
|
861
861
|
#
|
@@ -894,7 +894,7 @@ module Orb
|
|
894
894
|
|
895
895
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
|
896
896
|
# Some parameter documentations has been truncated, see
|
897
|
-
# {Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::
|
897
|
+
# {Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Percentage}
|
898
898
|
# for more details.
|
899
899
|
#
|
900
900
|
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
@@ -911,7 +911,7 @@ module Orb
|
|
911
911
|
# @param discount_type [Symbol, :percentage]
|
912
912
|
end
|
913
913
|
|
914
|
-
class
|
914
|
+
class Usage < Orb::Internal::Type::BaseModel
|
915
915
|
# @!attribute applies_to_price_ids
|
916
916
|
# The price ids that this discount interval applies to.
|
917
917
|
#
|
@@ -950,7 +950,7 @@ module Orb
|
|
950
950
|
|
951
951
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
|
952
952
|
# Some parameter documentations has been truncated, see
|
953
|
-
# {Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::
|
953
|
+
# {Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Usage}
|
954
954
|
# for more details.
|
955
955
|
#
|
956
956
|
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
@@ -968,7 +968,7 @@ module Orb
|
|
968
968
|
end
|
969
969
|
|
970
970
|
# @!method self.variants
|
971
|
-
# @return [Array(Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::
|
971
|
+
# @return [Array(Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Amount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Percentage, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Usage)]
|
972
972
|
end
|
973
973
|
|
974
974
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
@@ -1172,7 +1172,7 @@ module Orb
|
|
1172
1172
|
# For more on the types of prices, see
|
1173
1173
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1174
1174
|
#
|
1175
|
-
# @return [Orb::Models::Price::
|
1175
|
+
# @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]
|
1176
1176
|
required :price, union: -> { Orb::Models::Price }
|
1177
1177
|
|
1178
1178
|
# @!attribute start_date
|
@@ -1216,7 +1216,7 @@ module Orb
|
|
1216
1216
|
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionChangeCancelResponse::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1217
1217
|
# ...
|
1218
1218
|
#
|
1219
|
-
# @param price [Orb::Models::Price::
|
1219
|
+
# @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
|
1220
1220
|
# ...
|
1221
1221
|
#
|
1222
1222
|
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|