orb-billing 0.3.1 → 0.3.2
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 +14 -0
- data/README.md +3 -3
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/type/enum.rb +3 -3
- data/lib/orb/internal/type/request_parameters.rb +4 -4
- data/lib/orb/internal/type/union.rb +4 -4
- data/lib/orb/internal/util.rb +1 -1
- data/lib/orb/models/alert.rb +29 -32
- data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
- data/lib/orb/models/alert_list_params.rb +0 -1
- data/lib/orb/models/alert_update_params.rb +4 -5
- data/lib/orb/models/amount_discount.rb +6 -7
- data/lib/orb/models/billable_metric.rb +9 -11
- data/lib/orb/models/coupon.rb +9 -12
- data/lib/orb/models/coupon_create_params.rb +6 -8
- data/lib/orb/models/coupon_list_params.rb +0 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
- data/lib/orb/models/credit_note.rb +48 -46
- data/lib/orb/models/credit_note_create_params.rb +6 -6
- data/lib/orb/models/credit_note_list_params.rb +0 -1
- data/lib/orb/models/customer.rb +54 -61
- data/lib/orb/models/customer_create_params.rb +41 -53
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +41 -53
- data/lib/orb/models/customer_update_params.rb +41 -51
- data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
- data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
- data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
- data/lib/orb/models/customers/cost_list_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_response.rb +3 -3
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
- data/lib/orb/models/customers/credit_list_params.rb +0 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +0 -7
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
- data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
- data/lib/orb/models/dimensional_price_group.rb +1 -3
- data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
- data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
- data/lib/orb/models/dimensional_price_groups.rb +6 -6
- data/lib/orb/models/discount.rb +5 -5
- data/lib/orb/models/evaluate_price_group.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +4 -9
- data/lib/orb/models/event_ingest_response.rb +0 -3
- data/lib/orb/models/event_search_params.rb +0 -3
- data/lib/orb/models/event_search_response.rb +0 -4
- data/lib/orb/models/event_update_params.rb +0 -3
- data/lib/orb/models/events/backfill_close_response.rb +0 -4
- data/lib/orb/models/events/backfill_create_params.rb +0 -7
- data/lib/orb/models/events/backfill_create_response.rb +0 -4
- data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
- data/lib/orb/models/events/backfill_list_params.rb +0 -1
- data/lib/orb/models/events/backfill_list_response.rb +0 -4
- data/lib/orb/models/events/backfill_revert_response.rb +0 -4
- data/lib/orb/models/events/event_volumes.rb +3 -3
- data/lib/orb/models/events/volume_list_params.rb +0 -3
- data/lib/orb/models/invoice.rb +157 -202
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +9 -54
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +4 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +6 -26
- data/lib/orb/models/invoice_list_params.rb +6 -10
- data/lib/orb/models/invoice_update_params.rb +0 -1
- data/lib/orb/models/item.rb +7 -8
- data/lib/orb/models/item_list_params.rb +0 -1
- data/lib/orb/models/item_update_params.rb +7 -7
- data/lib/orb/models/metric_create_params.rb +0 -1
- data/lib/orb/models/metric_list_params.rb +0 -1
- data/lib/orb/models/metric_update_params.rb +0 -1
- data/lib/orb/models/percentage_discount.rb +6 -8
- data/lib/orb/models/plan.rb +78 -103
- data/lib/orb/models/plan_create_params.rb +727 -800
- data/lib/orb/models/plan_list_params.rb +3 -4
- data/lib/orb/models/plan_update_params.rb +0 -2
- data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
- data/lib/orb/models/price.rb +1671 -1724
- data/lib/orb/models/price_create_params.rb +75 -84
- data/lib/orb/models/price_evaluate_params.rb +0 -2
- data/lib/orb/models/price_evaluate_response.rb +3 -3
- data/lib/orb/models/price_list_params.rb +0 -1
- data/lib/orb/models/price_update_params.rb +0 -1
- data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
- data/lib/orb/models/subscription.rb +86 -122
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +21 -57
- data/lib/orb/models/subscription_change_apply_response.rb +21 -58
- data/lib/orb/models/subscription_change_cancel_response.rb +21 -58
- data/lib/orb/models/subscription_change_retrieve_response.rb +21 -58
- data/lib/orb/models/subscription_create_params.rb +1865 -1815
- data/lib/orb/models/subscription_create_response.rb +21 -57
- data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
- data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
- data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
- data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
- data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
- data/lib/orb/models/subscription_list_params.rb +3 -4
- data/lib/orb/models/subscription_price_intervals_params.rb +1105 -1017
- data/lib/orb/models/subscription_price_intervals_response.rb +21 -57
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1906 -1791
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +21 -57
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +21 -57
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +21 -57
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +4 -6
- data/lib/orb/models/subscription_update_trial_response.rb +21 -57
- data/lib/orb/models/subscription_usage.rb +46 -39
- data/lib/orb/models/subscriptions.rb +6 -6
- data/lib/orb/models/trial_discount.rb +6 -7
- data/lib/orb/models/usage_discount.rb +6 -8
- data/lib/orb/resources/alerts.rb +30 -31
- data/lib/orb/resources/coupons/subscriptions.rb +3 -4
- data/lib/orb/resources/coupons.rb +11 -21
- data/lib/orb/resources/credit_notes.rb +10 -11
- data/lib/orb/resources/customers/balance_transactions.rb +3 -4
- data/lib/orb/resources/customers/costs.rb +4 -6
- data/lib/orb/resources/customers/credits/ledger.rb +14 -33
- data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
- data/lib/orb/resources/customers/credits.rb +2 -6
- data/lib/orb/resources/customers.rb +40 -67
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
- data/lib/orb/resources/dimensional_price_groups.rb +8 -10
- data/lib/orb/resources/events/backfills.rb +2 -10
- data/lib/orb/resources/events/volume.rb +3 -6
- data/lib/orb/resources/events.rb +4 -12
- data/lib/orb/resources/invoice_line_items.rb +1 -2
- data/lib/orb/resources/invoices.rb +26 -43
- data/lib/orb/resources/items.rb +12 -13
- data/lib/orb/resources/metrics.rb +11 -14
- data/lib/orb/resources/plans/external_plan_id.rb +5 -7
- data/lib/orb/resources/plans.rb +14 -23
- data/lib/orb/resources/prices/external_price_id.rb +5 -6
- data/lib/orb/resources/prices.rb +25 -35
- data/lib/orb/resources/subscription_changes.rb +1 -1
- data/lib/orb/resources/subscriptions.rb +49 -107
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +1 -0
- data/rbi/orb/client.rbi +5 -4
- data/rbi/orb/errors.rbi +59 -28
- data/rbi/orb/file_part.rbi +9 -6
- data/rbi/orb/internal/page.rbi +19 -6
- data/rbi/orb/internal/transport/base_client.rbi +131 -73
- data/rbi/orb/internal/transport/pooled_net_requester.rbi +25 -12
- data/rbi/orb/internal/type/array_of.rbi +42 -34
- data/rbi/orb/internal/type/base_model.rbi +124 -65
- data/rbi/orb/internal/type/base_page.rbi +11 -7
- data/rbi/orb/internal/type/boolean.rbi +16 -10
- data/rbi/orb/internal/type/converter.rbi +66 -31
- data/rbi/orb/internal/type/enum.rbi +27 -15
- data/rbi/orb/internal/type/file_input.rbi +12 -10
- data/rbi/orb/internal/type/hash_of.rbi +34 -24
- data/rbi/orb/internal/type/request_parameters.rbi +12 -4
- data/rbi/orb/internal/type/union.rbi +60 -25
- data/rbi/orb/internal/type/unknown.rbi +20 -12
- data/rbi/orb/internal/util.rbi +210 -89
- data/rbi/orb/models/alert.rbi +107 -70
- data/rbi/orb/models/alert_create_for_customer_params.rbi +60 -27
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +68 -29
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +53 -26
- data/rbi/orb/models/alert_disable_params.rbi +17 -6
- data/rbi/orb/models/alert_enable_params.rbi +17 -6
- data/rbi/orb/models/alert_list_params.rbi +23 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +10 -4
- data/rbi/orb/models/alert_update_params.rbi +25 -14
- data/rbi/orb/models/amount_discount.rbi +28 -19
- data/rbi/orb/models/billable_metric.rbi +33 -26
- data/rbi/orb/models/billing_cycle_relative_date.rbi +11 -5
- data/rbi/orb/models/coupon.rbi +28 -20
- data/rbi/orb/models/coupon_archive_params.rbi +10 -4
- data/rbi/orb/models/coupon_create_params.rbi +72 -38
- data/rbi/orb/models/coupon_fetch_params.rbi +10 -4
- data/rbi/orb/models/coupon_list_params.rbi +18 -15
- data/rbi/orb/models/coupons/subscription_list_params.rbi +16 -6
- data/rbi/orb/models/credit_note.rbi +293 -158
- data/rbi/orb/models/credit_note_create_params.rbi +58 -29
- data/rbi/orb/models/credit_note_fetch_params.rbi +10 -4
- data/rbi/orb/models/credit_note_list_params.rbi +20 -17
- data/rbi/orb/models/customer.rbi +430 -329
- data/rbi/orb/models/customer_create_params.rbi +662 -325
- data/rbi/orb/models/customer_delete_params.rbi +10 -4
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +10 -4
- data/rbi/orb/models/customer_fetch_params.rbi +10 -4
- data/rbi/orb/models/customer_list_params.rbi +20 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +10 -4
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +10 -4
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +1136 -336
- data/rbi/orb/models/customer_update_params.rbi +661 -324
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +50 -21
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +154 -61
- data/rbi/orb/models/customers/balance_transaction_list_params.rbi +20 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +164 -59
- data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +56 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +162 -124
- data/rbi/orb/models/customers/cost_list_params.rbi +45 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +154 -123
- data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +48 -22
- data/rbi/orb/models/customers/credit_list_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_response.rbi +44 -21
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +106 -68
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +643 -434
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +117 -59
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +700 -425
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +102 -44
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +681 -432
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +123 -40
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +735 -389
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +74 -53
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +65 -48
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +84 -45
- data/rbi/orb/models/customers/credits/top_up_create_response.rbi +83 -43
- data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +16 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +9 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +70 -49
- data/rbi/orb/models/customers/credits/top_up_list_params.rbi +9 -5
- data/rbi/orb/models/customers/credits/top_up_list_response.rbi +84 -43
- data/rbi/orb/models/dimensional_price_group.rbi +18 -15
- data/rbi/orb/models/dimensional_price_group_create_params.rbi +19 -16
- data/rbi/orb/models/dimensional_price_group_list_params.rbi +16 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +10 -4
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +10 -9
- data/rbi/orb/models/dimensional_price_groups.rbi +18 -13
- data/rbi/orb/models/discount.rbi +11 -5
- data/rbi/orb/models/evaluate_price_group.rbi +28 -12
- data/rbi/orb/models/event_deprecate_params.rbi +10 -4
- data/rbi/orb/models/event_deprecate_response.rbi +8 -3
- data/rbi/orb/models/event_ingest_params.rbi +37 -31
- data/rbi/orb/models/event_ingest_response.rbi +63 -23
- data/rbi/orb/models/event_search_params.rbi +17 -14
- data/rbi/orb/models/event_search_response.rbi +33 -21
- data/rbi/orb/models/event_update_params.rbi +19 -16
- data/rbi/orb/models/event_update_response.rbi +8 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_close_response.rbi +64 -29
- data/rbi/orb/models/events/backfill_create_params.rbi +21 -18
- data/rbi/orb/models/events/backfill_create_response.rbi +63 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_fetch_response.rbi +64 -29
- data/rbi/orb/models/events/backfill_list_params.rbi +16 -6
- data/rbi/orb/models/events/backfill_list_response.rbi +62 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_revert_response.rbi +63 -29
- data/rbi/orb/models/events/event_volumes.rbi +32 -10
- data/rbi/orb/models/events/volume_list_params.rbi +18 -15
- data/rbi/orb/models/invoice.rbi +1286 -805
- data/rbi/orb/models/invoice_create_params.rbi +97 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +10 -4
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +15 -5
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +1991 -861
- data/rbi/orb/models/invoice_issue_params.rbi +16 -5
- data/rbi/orb/models/invoice_level_discount.rbi +11 -4
- data/rbi/orb/models/invoice_line_item_create_params.rbi +20 -17
- data/rbi/orb/models/invoice_line_item_create_response.rbi +573 -376
- data/rbi/orb/models/invoice_list_params.rbi +67 -47
- data/rbi/orb/models/invoice_mark_paid_params.rbi +17 -14
- data/rbi/orb/models/invoice_pay_params.rbi +10 -4
- data/rbi/orb/models/invoice_update_params.rbi +15 -10
- data/rbi/orb/models/invoice_void_params.rbi +10 -4
- data/rbi/orb/models/item.rbi +87 -39
- data/rbi/orb/models/item_create_params.rbi +14 -5
- data/rbi/orb/models/item_fetch_params.rbi +10 -4
- data/rbi/orb/models/item_list_params.rbi +16 -6
- data/rbi/orb/models/item_update_params.rbi +79 -39
- data/rbi/orb/models/metric_create_params.rbi +19 -16
- data/rbi/orb/models/metric_fetch_params.rbi +10 -4
- data/rbi/orb/models/metric_list_params.rbi +20 -17
- data/rbi/orb/models/metric_update_params.rbi +15 -10
- data/rbi/orb/models/pagination_metadata.rbi +16 -4
- data/rbi/orb/models/percentage_discount.rbi +32 -19
- data/rbi/orb/models/plan.rbi +496 -365
- data/rbi/orb/models/plan_create_params.rbi +4785 -2875
- data/rbi/orb/models/plan_fetch_params.rbi +10 -4
- data/rbi/orb/models/plan_list_params.rbi +34 -27
- data/rbi/orb/models/plan_update_params.rbi +16 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +10 -9
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +16 -13
- data/rbi/orb/models/price.rbi +9969 -5024
- data/rbi/orb/models/price_create_params.rbi +501 -245
- data/rbi/orb/models/price_evaluate_params.rbi +20 -17
- data/rbi/orb/models/price_evaluate_response.rbi +11 -6
- data/rbi/orb/models/price_fetch_params.rbi +10 -4
- data/rbi/orb/models/price_list_params.rbi +16 -6
- data/rbi/orb/models/price_update_params.rbi +15 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +10 -9
- data/rbi/orb/models/prices/external_price_id_update_params.rbi +15 -10
- data/rbi/orb/models/subscription.rbi +578 -420
- data/rbi/orb/models/subscription_cancel_params.rbi +44 -22
- data/rbi/orb/models/subscription_cancel_response.rbi +700 -438
- data/rbi/orb/models/subscription_change_apply_params.rbi +16 -13
- data/rbi/orb/models/subscription_change_apply_response.rbi +784 -504
- data/rbi/orb/models/subscription_change_cancel_params.rbi +10 -4
- data/rbi/orb/models/subscription_change_cancel_response.rbi +783 -514
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +10 -4
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +782 -524
- data/rbi/orb/models/subscription_create_params.rbi +9021 -6730
- data/rbi/orb/models/subscription_create_response.rbi +700 -438
- data/rbi/orb/models/subscription_fetch_costs_params.rbi +47 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +154 -123
- data/rbi/orb/models/subscription_fetch_params.rbi +10 -4
- data/rbi/orb/models/subscription_fetch_schedule_params.rbi +20 -17
- data/rbi/orb/models/subscription_fetch_schedule_response.rbi +33 -19
- data/rbi/orb/models/subscription_fetch_usage_params.rbi +81 -34
- data/rbi/orb/models/subscription_list_params.rbi +39 -28
- data/rbi/orb/models/subscription_price_intervals_params.rbi +5181 -3822
- data/rbi/orb/models/subscription_price_intervals_response.rbi +720 -453
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +8602 -6910
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +718 -467
- data/rbi/orb/models/subscription_trigger_phase_params.rbi +16 -13
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +712 -448
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +10 -4
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +719 -467
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +16 -5
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +693 -502
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +10 -4
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +708 -497
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +57 -26
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +719 -467
- data/rbi/orb/models/subscription_update_params.rbi +19 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +57 -19
- data/rbi/orb/models/subscription_update_trial_response.rbi +712 -447
- data/rbi/orb/models/subscription_usage.rbi +271 -121
- data/rbi/orb/models/subscriptions.rbi +18 -11
- data/rbi/orb/models/top_level_ping_params.rbi +10 -4
- data/rbi/orb/models/top_level_ping_response.rbi +7 -3
- data/rbi/orb/models/trial_discount.rbi +29 -20
- data/rbi/orb/models/usage_discount.rbi +28 -19
- data/rbi/orb/models.rbi +22 -11
- data/rbi/orb/request_options.rbi +12 -6
- data/rbi/orb/resources/alerts.rbi +61 -40
- data/rbi/orb/resources/coupons/subscriptions.rbi +7 -5
- data/rbi/orb/resources/coupons.rbi +33 -18
- data/rbi/orb/resources/credit_notes.rbi +22 -13
- data/rbi/orb/resources/customers/balance_transactions.rbi +17 -9
- data/rbi/orb/resources/customers/costs.rbi +18 -11
- data/rbi/orb/resources/customers/credits/ledger.rbi +98 -74
- data/rbi/orb/resources/customers/credits/top_ups.rbi +61 -25
- data/rbi/orb/resources/customers/credits.rbi +16 -7
- data/rbi/orb/resources/customers.rbi +137 -72
- data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +8 -4
- data/rbi/orb/resources/dimensional_price_groups.rbi +26 -12
- data/rbi/orb/resources/events/backfills.rbi +35 -17
- data/rbi/orb/resources/events/volume.rbi +7 -5
- data/rbi/orb/resources/events.rbi +26 -16
- data/rbi/orb/resources/invoice_line_items.rbi +7 -5
- data/rbi/orb/resources/invoices.rbi +72 -41
- data/rbi/orb/resources/items.rbi +40 -13
- data/rbi/orb/resources/metrics.rbi +25 -15
- data/rbi/orb/resources/plans/external_plan_id.rbi +15 -7
- data/rbi/orb/resources/plans.rbi +57 -47
- data/rbi/orb/resources/prices/external_price_id.rbi +73 -68
- data/rbi/orb/resources/prices.rbi +176 -156
- data/rbi/orb/resources/subscription_changes.rbi +19 -11
- data/rbi/orb/resources/subscriptions.rbi +200 -114
- data/rbi/orb/resources/top_level.rbi +9 -3
- data/sig/orb/internal/page.rbs +0 -2
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/models/alert.rbs +19 -31
- data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
- data/sig/orb/models/alert_disable_params.rbs +0 -2
- data/sig/orb/models/alert_enable_params.rbs +0 -2
- data/sig/orb/models/alert_list_params.rbs +0 -2
- data/sig/orb/models/alert_retrieve_params.rbs +0 -2
- data/sig/orb/models/alert_update_params.rbs +3 -7
- data/sig/orb/models/amount_discount.rbs +4 -6
- data/sig/orb/models/billable_metric.rbs +7 -9
- data/sig/orb/models/coupon.rbs +5 -8
- data/sig/orb/models/coupon_archive_params.rbs +0 -2
- data/sig/orb/models/coupon_create_params.rbs +3 -9
- data/sig/orb/models/coupon_fetch_params.rbs +0 -2
- data/sig/orb/models/coupon_list_params.rbs +0 -2
- data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
- data/sig/orb/models/credit_note.rbs +48 -66
- data/sig/orb/models/credit_note_create_params.rbs +3 -7
- data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
- data/sig/orb/models/credit_note_list_params.rbs +0 -2
- data/sig/orb/models/customer.rbs +43 -63
- data/sig/orb/models/customer_create_params.rbs +32 -52
- data/sig/orb/models/customer_delete_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_params.rbs +0 -2
- data/sig/orb/models/customer_list_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
- data/sig/orb/models/customer_update_by_external_id_params.rbs +32 -52
- data/sig/orb/models/customer_update_params.rbs +32 -52
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_response.rbs +0 -6
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
- data/sig/orb/models/customers/credit_list_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_response.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +1 -43
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
- data/sig/orb/models/dimensional_price_group.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups.rbs +6 -8
- data/sig/orb/models/discount.rbs +5 -5
- data/sig/orb/models/evaluate_price_group.rbs +4 -6
- data/sig/orb/models/event_deprecate_params.rbs +0 -2
- data/sig/orb/models/event_deprecate_response.rbs +0 -2
- data/sig/orb/models/event_ingest_params.rbs +3 -7
- data/sig/orb/models/event_ingest_response.rbs +0 -6
- data/sig/orb/models/event_search_params.rbs +0 -2
- data/sig/orb/models/event_search_response.rbs +0 -4
- data/sig/orb/models/event_update_params.rbs +0 -2
- data/sig/orb/models/event_update_response.rbs +0 -2
- data/sig/orb/models/events/backfill_close_params.rbs +0 -2
- data/sig/orb/models/events/backfill_close_response.rbs +0 -2
- data/sig/orb/models/events/backfill_create_params.rbs +0 -2
- data/sig/orb/models/events/backfill_create_response.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
- data/sig/orb/models/events/backfill_list_params.rbs +0 -2
- data/sig/orb/models/events/backfill_list_response.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
- data/sig/orb/models/events/event_volumes.rbs +3 -10
- data/sig/orb/models/events/volume_list_params.rbs +0 -2
- data/sig/orb/models/invoice.rbs +110 -172
- data/sig/orb/models/invoice_create_params.rbs +10 -16
- data/sig/orb/models/invoice_fetch_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +2 -64
- data/sig/orb/models/invoice_issue_params.rbs +0 -2
- data/sig/orb/models/invoice_level_discount.rbs +2 -4
- data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
- data/sig/orb/models/invoice_line_item_create_response.rbs +2 -36
- data/sig/orb/models/invoice_list_params.rbs +4 -6
- data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
- data/sig/orb/models/invoice_pay_params.rbs +0 -2
- data/sig/orb/models/invoice_update_params.rbs +0 -2
- data/sig/orb/models/invoice_void_params.rbs +0 -2
- data/sig/orb/models/item.rbs +7 -11
- data/sig/orb/models/item_create_params.rbs +0 -2
- data/sig/orb/models/item_fetch_params.rbs +0 -2
- data/sig/orb/models/item_list_params.rbs +0 -2
- data/sig/orb/models/item_update_params.rbs +7 -11
- data/sig/orb/models/metric_create_params.rbs +0 -2
- data/sig/orb/models/metric_fetch_params.rbs +0 -2
- data/sig/orb/models/metric_list_params.rbs +0 -2
- data/sig/orb/models/metric_update_params.rbs +0 -2
- data/sig/orb/models/pagination_metadata.rbs +0 -2
- data/sig/orb/models/percentage_discount.rbs +4 -6
- data/sig/orb/models/plan.rbs +45 -73
- data/sig/orb/models/plan_create_params.rbs +518 -696
- data/sig/orb/models/plan_fetch_params.rbs +0 -2
- data/sig/orb/models/plan_list_params.rbs +0 -2
- data/sig/orb/models/plan_update_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
- data/sig/orb/models/price.rbs +1194 -1730
- data/sig/orb/models/price_create_params.rbs +59 -97
- data/sig/orb/models/price_evaluate_params.rbs +0 -2
- data/sig/orb/models/price_evaluate_response.rbs +3 -6
- data/sig/orb/models/price_fetch_params.rbs +0 -2
- data/sig/orb/models/price_list_params.rbs +0 -2
- data/sig/orb/models/price_update_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
- data/sig/orb/models/subscription.rbs +56 -94
- data/sig/orb/models/subscription_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_cancel_response.rbs +20 -60
- data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
- data/sig/orb/models/subscription_change_apply_response.rbs +20 -62
- data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_change_cancel_response.rbs +20 -62
- data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
- data/sig/orb/models/subscription_change_retrieve_response.rbs +20 -62
- data/sig/orb/models/subscription_create_params.rbs +1103 -1499
- data/sig/orb/models/subscription_create_response.rbs +20 -60
- data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
- data/sig/orb/models/subscription_fetch_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
- data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
- data/sig/orb/models/subscription_list_params.rbs +0 -2
- data/sig/orb/models/subscription_price_intervals_params.rbs +666 -896
- data/sig/orb/models/subscription_price_intervals_response.rbs +20 -60
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1103 -1499
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +20 -60
- data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +20 -60
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +20 -60
- data/sig/orb/models/subscription_update_params.rbs +0 -2
- data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
- data/sig/orb/models/subscription_update_trial_response.rbs +20 -60
- data/sig/orb/models/subscription_usage.rbs +35 -53
- data/sig/orb/models/subscriptions.rbs +6 -8
- data/sig/orb/models/top_level_ping_params.rbs +0 -2
- data/sig/orb/models/top_level_ping_response.rbs +0 -2
- data/sig/orb/models/trial_discount.rbs +4 -6
- data/sig/orb/models/usage_discount.rbs +4 -6
- data/sig/orb/request_options.rbs +1 -1
- data/sig/orb/resources/alerts.rbs +12 -12
- data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
- data/sig/orb/resources/coupons.rbs +4 -4
- data/sig/orb/resources/credit_notes.rbs +4 -4
- data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
- data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
- data/sig/orb/resources/customers.rbs +24 -24
- data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
- data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
- data/sig/orb/resources/events/volume.rbs +1 -1
- data/sig/orb/resources/events.rbs +1 -1
- data/sig/orb/resources/invoices.rbs +10 -10
- data/sig/orb/resources/items.rbs +5 -5
- data/sig/orb/resources/metrics.rbs +4 -4
- data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
- data/sig/orb/resources/plans.rbs +5 -5
- data/sig/orb/resources/prices.rbs +11 -11
- data/sig/orb/resources/subscriptions.rbs +21 -21
- metadata +2 -2
@@ -88,8 +88,8 @@ module Orb
|
|
88
88
|
# your account's timezone. See [Timezone localization](/essentials/timezones) for
|
89
89
|
# information on what this timezone parameter influences within Orb.
|
90
90
|
#
|
91
|
-
# @return [Orb::
|
92
|
-
required :customer, -> { Orb::
|
91
|
+
# @return [Orb::Customer]
|
92
|
+
required :customer, -> { Orb::Customer }
|
93
93
|
|
94
94
|
# @!attribute default_invoice_memo
|
95
95
|
# Determines the default memo on this subscriptions' invoices. Note that if this
|
@@ -168,8 +168,8 @@ module Orb
|
|
168
168
|
# subscription. You can see more about how to configure prices in the
|
169
169
|
# [Price resource](/reference/price).
|
170
170
|
#
|
171
|
-
# @return [Orb::
|
172
|
-
required :plan, -> { Orb::
|
171
|
+
# @return [Orb::Plan]
|
172
|
+
required :plan, -> { Orb::Plan }
|
173
173
|
|
174
174
|
# @!attribute price_intervals
|
175
175
|
# The price intervals for this subscription.
|
@@ -219,32 +219,24 @@ module Orb
|
|
219
219
|
# @param id [String]
|
220
220
|
#
|
221
221
|
# @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
|
222
|
-
# ...
|
223
222
|
#
|
224
223
|
# @param adjustment_intervals [Array<Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
|
225
|
-
# ...
|
226
224
|
#
|
227
225
|
# @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
|
228
|
-
# ...
|
229
226
|
#
|
230
227
|
# @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::BillingCycleAnchorConfiguration]
|
231
228
|
#
|
232
229
|
# @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
233
|
-
# ...
|
234
230
|
#
|
235
231
|
# @param created_at [Time]
|
236
232
|
#
|
237
233
|
# @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
|
238
|
-
# ...
|
239
234
|
#
|
240
235
|
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
241
|
-
# ...
|
242
236
|
#
|
243
|
-
# @param customer [Orb::
|
244
|
-
# ...
|
237
|
+
# @param customer [Orb::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
245
238
|
#
|
246
239
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
247
|
-
# ...
|
248
240
|
#
|
249
241
|
# @param discount_intervals [Array<Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
|
250
242
|
#
|
@@ -257,17 +249,14 @@ module Orb
|
|
257
249
|
# @param maximum_intervals [Array<Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
|
258
250
|
#
|
259
251
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
260
|
-
# ...
|
261
252
|
#
|
262
253
|
# @param minimum_intervals [Array<Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
|
263
254
|
#
|
264
255
|
# @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
|
265
|
-
# ...
|
266
256
|
#
|
267
257
|
# @param pending_subscription_change [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
268
258
|
#
|
269
|
-
# @param plan [Orb::
|
270
|
-
# ...
|
259
|
+
# @param plan [Orb::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
271
260
|
#
|
272
261
|
# @param price_intervals [Array<Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval>] The price intervals for this subscription.
|
273
262
|
#
|
@@ -280,7 +269,6 @@ module Orb
|
|
280
269
|
# @param trial_info [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo]
|
281
270
|
#
|
282
271
|
# @param changed_resources [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet
|
283
|
-
# ...
|
284
272
|
|
285
273
|
class AdjustmentInterval < Orb::Internal::Type::BaseModel
|
286
274
|
# @!attribute id
|
@@ -397,14 +385,12 @@ module Orb
|
|
397
385
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
398
386
|
#
|
399
387
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
400
|
-
# ...
|
401
388
|
#
|
402
389
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
403
390
|
#
|
404
391
|
# @param reason [String, nil] The reason for the adjustment.
|
405
392
|
#
|
406
393
|
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
407
|
-
# ...
|
408
394
|
#
|
409
395
|
# @param adjustment_type [Symbol, :usage_discount]
|
410
396
|
end
|
@@ -460,12 +446,10 @@ module Orb
|
|
460
446
|
# @param id [String]
|
461
447
|
#
|
462
448
|
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
463
|
-
# ...
|
464
449
|
#
|
465
450
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
466
451
|
#
|
467
452
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
468
|
-
# ...
|
469
453
|
#
|
470
454
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
471
455
|
#
|
@@ -527,10 +511,8 @@ module Orb
|
|
527
511
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
528
512
|
#
|
529
513
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
530
|
-
# ...
|
531
514
|
#
|
532
515
|
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
533
|
-
# ...
|
534
516
|
#
|
535
517
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
536
518
|
#
|
@@ -598,12 +580,10 @@ module Orb
|
|
598
580
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
599
581
|
#
|
600
582
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
601
|
-
# ...
|
602
583
|
#
|
603
584
|
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
604
585
|
#
|
605
586
|
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
606
|
-
# ...
|
607
587
|
#
|
608
588
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
609
589
|
#
|
@@ -665,10 +645,8 @@ module Orb
|
|
665
645
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
666
646
|
#
|
667
647
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
668
|
-
# ...
|
669
648
|
#
|
670
649
|
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
671
|
-
# ...
|
672
650
|
#
|
673
651
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
674
652
|
#
|
@@ -714,13 +692,10 @@ module Orb
|
|
714
692
|
# for more details.
|
715
693
|
#
|
716
694
|
# @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
717
|
-
# ...
|
718
695
|
#
|
719
696
|
# @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore
|
720
|
-
# ...
|
721
697
|
#
|
722
698
|
# @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc
|
723
|
-
# ...
|
724
699
|
end
|
725
700
|
|
726
701
|
module DiscountInterval
|
@@ -836,7 +811,6 @@ module Orb
|
|
836
811
|
# @param end_date [Time, nil] The end date of the discount interval.
|
837
812
|
#
|
838
813
|
# @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
|
839
|
-
# ...
|
840
814
|
#
|
841
815
|
# @param start_date [Time] The start date of the discount interval.
|
842
816
|
#
|
@@ -894,7 +868,6 @@ module Orb
|
|
894
868
|
# @param start_date [Time] The start date of the discount interval.
|
895
869
|
#
|
896
870
|
# @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
|
897
|
-
# ...
|
898
871
|
#
|
899
872
|
# @param discount_type [Symbol, :usage]
|
900
873
|
end
|
@@ -975,7 +948,6 @@ module Orb
|
|
975
948
|
# @param end_date [Time, nil] The end date of the maximum interval.
|
976
949
|
#
|
977
950
|
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
|
978
|
-
# ...
|
979
951
|
#
|
980
952
|
# @param start_date [Time] The start date of the maximum interval.
|
981
953
|
end
|
@@ -1024,7 +996,6 @@ module Orb
|
|
1024
996
|
# @param end_date [Time, nil] The end date of the minimum interval.
|
1025
997
|
#
|
1026
998
|
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
|
1027
|
-
# ...
|
1028
999
|
#
|
1029
1000
|
# @param start_date [Time] The start date of the minimum interval.
|
1030
1001
|
end
|
@@ -1104,8 +1075,8 @@ module Orb
|
|
1104
1075
|
# For more on the types of prices, see
|
1105
1076
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1106
1077
|
#
|
1107
|
-
# @return [Orb::
|
1108
|
-
required :price, union: -> { Orb::
|
1078
|
+
# @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
|
1079
|
+
required :price, union: -> { Orb::Price }
|
1109
1080
|
|
1110
1081
|
# @!attribute start_date
|
1111
1082
|
# The start date of the price interval. This is the date that Orb starts billing
|
@@ -1135,27 +1106,20 @@ module Orb
|
|
1135
1106
|
# @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
|
1136
1107
|
#
|
1137
1108
|
# @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
|
1138
|
-
# ...
|
1139
1109
|
#
|
1140
1110
|
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
1141
|
-
# ...
|
1142
1111
|
#
|
1143
1112
|
# @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for
|
1144
|
-
# ...
|
1145
1113
|
#
|
1146
1114
|
# @param filter [String, nil] An additional filter to apply to usage queries.
|
1147
1115
|
#
|
1148
1116
|
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1149
|
-
# ...
|
1150
1117
|
#
|
1151
|
-
# @param price [Orb::
|
1152
|
-
# ...
|
1118
|
+
# @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
|
1153
1119
|
#
|
1154
1120
|
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
1155
|
-
# ...
|
1156
1121
|
#
|
1157
1122
|
# @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
|
1158
|
-
# ...
|
1159
1123
|
|
1160
1124
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
1161
1125
|
# @!attribute effective_date
|
@@ -1231,39 +1195,39 @@ module Orb
|
|
1231
1195
|
# @!attribute created_credit_notes
|
1232
1196
|
# The credit notes that were created as part of this operation.
|
1233
1197
|
#
|
1234
|
-
# @return [Array<Orb::
|
1235
|
-
required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::
|
1198
|
+
# @return [Array<Orb::CreditNote>]
|
1199
|
+
required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
|
1236
1200
|
|
1237
1201
|
# @!attribute created_invoices
|
1238
1202
|
# The invoices that were created as part of this operation.
|
1239
1203
|
#
|
1240
|
-
# @return [Array<Orb::
|
1241
|
-
required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::
|
1204
|
+
# @return [Array<Orb::Invoice>]
|
1205
|
+
required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
|
1242
1206
|
|
1243
1207
|
# @!attribute voided_credit_notes
|
1244
1208
|
# The credit notes that were voided as part of this operation.
|
1245
1209
|
#
|
1246
|
-
# @return [Array<Orb::
|
1247
|
-
required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::
|
1210
|
+
# @return [Array<Orb::CreditNote>]
|
1211
|
+
required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
|
1248
1212
|
|
1249
1213
|
# @!attribute voided_invoices
|
1250
1214
|
# The invoices that were voided as part of this operation.
|
1251
1215
|
#
|
1252
|
-
# @return [Array<Orb::
|
1253
|
-
required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::
|
1216
|
+
# @return [Array<Orb::Invoice>]
|
1217
|
+
required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
|
1254
1218
|
|
1255
1219
|
# @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
|
1256
1220
|
# The resources that were changed as part of this operation. Only present when
|
1257
1221
|
# fetched through the subscription changes API or if the
|
1258
1222
|
# `include_changed_resources` parameter was passed in the request.
|
1259
1223
|
#
|
1260
|
-
# @param created_credit_notes [Array<Orb::
|
1224
|
+
# @param created_credit_notes [Array<Orb::CreditNote>] The credit notes that were created as part of this operation.
|
1261
1225
|
#
|
1262
|
-
# @param created_invoices [Array<Orb::
|
1226
|
+
# @param created_invoices [Array<Orb::Invoice>] The invoices that were created as part of this operation.
|
1263
1227
|
#
|
1264
|
-
# @param voided_credit_notes [Array<Orb::
|
1228
|
+
# @param voided_credit_notes [Array<Orb::CreditNote>] The credit notes that were voided as part of this operation.
|
1265
1229
|
#
|
1266
|
-
# @param voided_invoices [Array<Orb::
|
1230
|
+
# @param voided_invoices [Array<Orb::Invoice>] The invoices that were voided as part of this operation.
|
1267
1231
|
end
|
1268
1232
|
end
|
1269
1233
|
end
|
@@ -31,8 +31,8 @@ module Orb
|
|
31
31
|
# specified, this defaults to `effective_date`. Otherwise, this defaults to
|
32
32
|
# `immediate` unless it's explicitly set to `upcoming_invoice`.
|
33
33
|
#
|
34
|
-
# @return [Symbol, Orb::
|
35
|
-
optional :change_option, enum: -> { Orb::
|
34
|
+
# @return [Symbol, Orb::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption, nil]
|
35
|
+
optional :change_option, enum: -> { Orb::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption }
|
36
36
|
|
37
37
|
# @!attribute effective_date
|
38
38
|
# The date that the quantity change should take effect, localized to the
|
@@ -51,13 +51,10 @@ module Orb
|
|
51
51
|
# @param quantity [Float]
|
52
52
|
#
|
53
53
|
# @param allow_invoice_credit_or_void [Boolean, nil] If false, this request will fail if it would void an issued invoice or create a
|
54
|
-
# ...
|
55
54
|
#
|
56
|
-
# @param change_option [Symbol, Orb::
|
57
|
-
# ...
|
55
|
+
# @param change_option [Symbol, Orb::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption] Determines when the change takes effect. Note that if `effective_date` is specif
|
58
56
|
#
|
59
57
|
# @param effective_date [Date, nil] The date that the quantity change should take effect, localized to the customer'
|
60
|
-
# ...
|
61
58
|
#
|
62
59
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
63
60
|
|
@@ -88,8 +88,8 @@ module Orb
|
|
88
88
|
# your account's timezone. See [Timezone localization](/essentials/timezones) for
|
89
89
|
# information on what this timezone parameter influences within Orb.
|
90
90
|
#
|
91
|
-
# @return [Orb::
|
92
|
-
required :customer, -> { Orb::
|
91
|
+
# @return [Orb::Customer]
|
92
|
+
required :customer, -> { Orb::Customer }
|
93
93
|
|
94
94
|
# @!attribute default_invoice_memo
|
95
95
|
# Determines the default memo on this subscriptions' invoices. Note that if this
|
@@ -168,8 +168,8 @@ module Orb
|
|
168
168
|
# subscription. You can see more about how to configure prices in the
|
169
169
|
# [Price resource](/reference/price).
|
170
170
|
#
|
171
|
-
# @return [Orb::
|
172
|
-
required :plan, -> { Orb::
|
171
|
+
# @return [Orb::Plan]
|
172
|
+
required :plan, -> { Orb::Plan }
|
173
173
|
|
174
174
|
# @!attribute price_intervals
|
175
175
|
# The price intervals for this subscription.
|
@@ -218,32 +218,24 @@ module Orb
|
|
218
218
|
# @param id [String]
|
219
219
|
#
|
220
220
|
# @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
|
221
|
-
# ...
|
222
221
|
#
|
223
222
|
# @param adjustment_intervals [Array<Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
|
224
|
-
# ...
|
225
223
|
#
|
226
224
|
# @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
|
227
|
-
# ...
|
228
225
|
#
|
229
226
|
# @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::BillingCycleAnchorConfiguration]
|
230
227
|
#
|
231
228
|
# @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
232
|
-
# ...
|
233
229
|
#
|
234
230
|
# @param created_at [Time]
|
235
231
|
#
|
236
232
|
# @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
|
237
|
-
# ...
|
238
233
|
#
|
239
234
|
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
240
|
-
# ...
|
241
235
|
#
|
242
|
-
# @param customer [Orb::
|
243
|
-
# ...
|
236
|
+
# @param customer [Orb::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
244
237
|
#
|
245
238
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
246
|
-
# ...
|
247
239
|
#
|
248
240
|
# @param discount_intervals [Array<Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
|
249
241
|
#
|
@@ -256,17 +248,14 @@ module Orb
|
|
256
248
|
# @param maximum_intervals [Array<Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
|
257
249
|
#
|
258
250
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
259
|
-
# ...
|
260
251
|
#
|
261
252
|
# @param minimum_intervals [Array<Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
|
262
253
|
#
|
263
254
|
# @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
|
264
|
-
# ...
|
265
255
|
#
|
266
256
|
# @param pending_subscription_change [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
267
257
|
#
|
268
|
-
# @param plan [Orb::
|
269
|
-
# ...
|
258
|
+
# @param plan [Orb::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
270
259
|
#
|
271
260
|
# @param price_intervals [Array<Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval>] The price intervals for this subscription.
|
272
261
|
#
|
@@ -279,7 +268,6 @@ module Orb
|
|
279
268
|
# @param trial_info [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::TrialInfo]
|
280
269
|
#
|
281
270
|
# @param changed_resources [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet
|
282
|
-
# ...
|
283
271
|
|
284
272
|
class AdjustmentInterval < Orb::Internal::Type::BaseModel
|
285
273
|
# @!attribute id
|
@@ -396,14 +384,12 @@ module Orb
|
|
396
384
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
397
385
|
#
|
398
386
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
399
|
-
# ...
|
400
387
|
#
|
401
388
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
402
389
|
#
|
403
390
|
# @param reason [String, nil] The reason for the adjustment.
|
404
391
|
#
|
405
392
|
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
406
|
-
# ...
|
407
393
|
#
|
408
394
|
# @param adjustment_type [Symbol, :usage_discount]
|
409
395
|
end
|
@@ -459,12 +445,10 @@ module Orb
|
|
459
445
|
# @param id [String]
|
460
446
|
#
|
461
447
|
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
462
|
-
# ...
|
463
448
|
#
|
464
449
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
465
450
|
#
|
466
451
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
467
|
-
# ...
|
468
452
|
#
|
469
453
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
470
454
|
#
|
@@ -526,10 +510,8 @@ module Orb
|
|
526
510
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
527
511
|
#
|
528
512
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
529
|
-
# ...
|
530
513
|
#
|
531
514
|
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
532
|
-
# ...
|
533
515
|
#
|
534
516
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
535
517
|
#
|
@@ -597,12 +579,10 @@ module Orb
|
|
597
579
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
598
580
|
#
|
599
581
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
600
|
-
# ...
|
601
582
|
#
|
602
583
|
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
603
584
|
#
|
604
585
|
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
605
|
-
# ...
|
606
586
|
#
|
607
587
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
608
588
|
#
|
@@ -664,10 +644,8 @@ module Orb
|
|
664
644
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
665
645
|
#
|
666
646
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
667
|
-
# ...
|
668
647
|
#
|
669
648
|
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
670
|
-
# ...
|
671
649
|
#
|
672
650
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
673
651
|
#
|
@@ -713,13 +691,10 @@ module Orb
|
|
713
691
|
# for more details.
|
714
692
|
#
|
715
693
|
# @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
716
|
-
# ...
|
717
694
|
#
|
718
695
|
# @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore
|
719
|
-
# ...
|
720
696
|
#
|
721
697
|
# @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc
|
722
|
-
# ...
|
723
698
|
end
|
724
699
|
|
725
700
|
module DiscountInterval
|
@@ -833,7 +808,6 @@ module Orb
|
|
833
808
|
# @param end_date [Time, nil] The end date of the discount interval.
|
834
809
|
#
|
835
810
|
# @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
|
836
|
-
# ...
|
837
811
|
#
|
838
812
|
# @param start_date [Time] The start date of the discount interval.
|
839
813
|
#
|
@@ -891,7 +865,6 @@ module Orb
|
|
891
865
|
# @param start_date [Time] The start date of the discount interval.
|
892
866
|
#
|
893
867
|
# @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
|
894
|
-
# ...
|
895
868
|
#
|
896
869
|
# @param discount_type [Symbol, :usage]
|
897
870
|
end
|
@@ -972,7 +945,6 @@ module Orb
|
|
972
945
|
# @param end_date [Time, nil] The end date of the maximum interval.
|
973
946
|
#
|
974
947
|
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
|
975
|
-
# ...
|
976
948
|
#
|
977
949
|
# @param start_date [Time] The start date of the maximum interval.
|
978
950
|
end
|
@@ -1021,7 +993,6 @@ module Orb
|
|
1021
993
|
# @param end_date [Time, nil] The end date of the minimum interval.
|
1022
994
|
#
|
1023
995
|
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
|
1024
|
-
# ...
|
1025
996
|
#
|
1026
997
|
# @param start_date [Time] The start date of the minimum interval.
|
1027
998
|
end
|
@@ -1101,8 +1072,8 @@ module Orb
|
|
1101
1072
|
# For more on the types of prices, see
|
1102
1073
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1103
1074
|
#
|
1104
|
-
# @return [Orb::
|
1105
|
-
required :price, union: -> { Orb::
|
1075
|
+
# @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
|
1076
|
+
required :price, union: -> { Orb::Price }
|
1106
1077
|
|
1107
1078
|
# @!attribute start_date
|
1108
1079
|
# The start date of the price interval. This is the date that Orb starts billing
|
@@ -1132,27 +1103,20 @@ module Orb
|
|
1132
1103
|
# @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
|
1133
1104
|
#
|
1134
1105
|
# @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
|
1135
|
-
# ...
|
1136
1106
|
#
|
1137
1107
|
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
1138
|
-
# ...
|
1139
1108
|
#
|
1140
1109
|
# @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for
|
1141
|
-
# ...
|
1142
1110
|
#
|
1143
1111
|
# @param filter [String, nil] An additional filter to apply to usage queries.
|
1144
1112
|
#
|
1145
1113
|
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1146
|
-
# ...
|
1147
1114
|
#
|
1148
|
-
# @param price [Orb::
|
1149
|
-
# ...
|
1115
|
+
# @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
|
1150
1116
|
#
|
1151
1117
|
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
1152
|
-
# ...
|
1153
1118
|
#
|
1154
1119
|
# @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
|
1155
|
-
# ...
|
1156
1120
|
|
1157
1121
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
1158
1122
|
# @!attribute effective_date
|
@@ -1228,39 +1192,39 @@ module Orb
|
|
1228
1192
|
# @!attribute created_credit_notes
|
1229
1193
|
# The credit notes that were created as part of this operation.
|
1230
1194
|
#
|
1231
|
-
# @return [Array<Orb::
|
1232
|
-
required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::
|
1195
|
+
# @return [Array<Orb::CreditNote>]
|
1196
|
+
required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
|
1233
1197
|
|
1234
1198
|
# @!attribute created_invoices
|
1235
1199
|
# The invoices that were created as part of this operation.
|
1236
1200
|
#
|
1237
|
-
# @return [Array<Orb::
|
1238
|
-
required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::
|
1201
|
+
# @return [Array<Orb::Invoice>]
|
1202
|
+
required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
|
1239
1203
|
|
1240
1204
|
# @!attribute voided_credit_notes
|
1241
1205
|
# The credit notes that were voided as part of this operation.
|
1242
1206
|
#
|
1243
|
-
# @return [Array<Orb::
|
1244
|
-
required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::
|
1207
|
+
# @return [Array<Orb::CreditNote>]
|
1208
|
+
required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
|
1245
1209
|
|
1246
1210
|
# @!attribute voided_invoices
|
1247
1211
|
# The invoices that were voided as part of this operation.
|
1248
1212
|
#
|
1249
|
-
# @return [Array<Orb::
|
1250
|
-
required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::
|
1213
|
+
# @return [Array<Orb::Invoice>]
|
1214
|
+
required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
|
1251
1215
|
|
1252
1216
|
# @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
|
1253
1217
|
# The resources that were changed as part of this operation. Only present when
|
1254
1218
|
# fetched through the subscription changes API or if the
|
1255
1219
|
# `include_changed_resources` parameter was passed in the request.
|
1256
1220
|
#
|
1257
|
-
# @param created_credit_notes [Array<Orb::
|
1221
|
+
# @param created_credit_notes [Array<Orb::CreditNote>] The credit notes that were created as part of this operation.
|
1258
1222
|
#
|
1259
|
-
# @param created_invoices [Array<Orb::
|
1223
|
+
# @param created_invoices [Array<Orb::Invoice>] The invoices that were created as part of this operation.
|
1260
1224
|
#
|
1261
|
-
# @param voided_credit_notes [Array<Orb::
|
1225
|
+
# @param voided_credit_notes [Array<Orb::CreditNote>] The credit notes that were voided as part of this operation.
|
1262
1226
|
#
|
1263
|
-
# @param voided_invoices [Array<Orb::
|
1227
|
+
# @param voided_invoices [Array<Orb::Invoice>] The invoices that were voided as part of this operation.
|
1264
1228
|
end
|
1265
1229
|
end
|
1266
1230
|
end
|
@@ -52,19 +52,14 @@ module Orb
|
|
52
52
|
# {Orb::Models::SubscriptionUpdateParams} for more details.
|
53
53
|
#
|
54
54
|
# @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
|
55
|
-
# ...
|
56
55
|
#
|
57
56
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscription's invoices. Note that if this i
|
58
|
-
# ...
|
59
57
|
#
|
60
58
|
# @param invoicing_threshold [String, nil] When this subscription's accrued usage reaches this threshold, an invoice will b
|
61
|
-
# ...
|
62
59
|
#
|
63
60
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
64
|
-
# ...
|
65
61
|
#
|
66
62
|
# @param net_terms [Integer, nil] Determines the difference between the invoice issue date for subscription invoic
|
67
|
-
# ...
|
68
63
|
#
|
69
64
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
70
65
|
end
|
@@ -11,8 +11,8 @@ module Orb
|
|
11
11
|
# The new date that the trial should end, or the literal string `immediate` to end
|
12
12
|
# the trial immediately.
|
13
13
|
#
|
14
|
-
# @return [Time, Symbol, Orb::
|
15
|
-
required :trial_end_date, union: -> { Orb::
|
14
|
+
# @return [Time, Symbol, Orb::SubscriptionUpdateTrialParams::TrialEndDate]
|
15
|
+
required :trial_end_date, union: -> { Orb::SubscriptionUpdateTrialParams::TrialEndDate }
|
16
16
|
|
17
17
|
# @!attribute shift
|
18
18
|
# If true, shifts subsequent price and adjustment intervals (preserving their
|
@@ -25,11 +25,9 @@ module Orb
|
|
25
25
|
# Some parameter documentations has been truncated, see
|
26
26
|
# {Orb::Models::SubscriptionUpdateTrialParams} for more details.
|
27
27
|
#
|
28
|
-
# @param trial_end_date [Time, Symbol, Orb::
|
29
|
-
# ...
|
28
|
+
# @param trial_end_date [Time, Symbol, Orb::SubscriptionUpdateTrialParams::TrialEndDate] The new date that the trial should end, or the literal string `immediate` to end
|
30
29
|
#
|
31
30
|
# @param shift [Boolean] If true, shifts subsequent price and adjustment intervals (preserving their dura
|
32
|
-
# ...
|
33
31
|
#
|
34
32
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
35
33
|
|
@@ -40,7 +38,7 @@ module Orb
|
|
40
38
|
|
41
39
|
variant Time
|
42
40
|
|
43
|
-
variant const: -> { Orb::
|
41
|
+
variant const: -> { Orb::SubscriptionUpdateTrialParams::TrialEndDate::IMMEDIATE }
|
44
42
|
|
45
43
|
# @!method self.variants
|
46
44
|
# @return [Array(Time, Symbol)]
|