orb-billing 0.1.0.pre.alpha.37 → 0.1.0.pre.alpha.39
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/README.md +29 -5
- data/lib/orb/client.rb +4 -0
- data/lib/orb/internal/page.rb +6 -2
- data/lib/orb/internal/transport/base_client.rb +3 -3
- data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
- data/lib/orb/internal/type/array_of.rb +5 -3
- data/lib/orb/internal/type/base_model.rb +19 -16
- data/lib/orb/internal/type/base_page.rb +4 -1
- data/lib/orb/internal/type/{boolean_model.rb → boolean.rb} +2 -2
- data/lib/orb/internal/type/converter.rb +26 -23
- data/lib/orb/internal/type/enum.rb +10 -8
- data/lib/orb/internal/type/hash_of.rb +3 -1
- data/lib/orb/internal/util.rb +29 -50
- data/lib/orb/models/alert.rb +10 -10
- data/lib/orb/models/alert_create_for_customer_params.rb +3 -3
- data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -3
- data/lib/orb/models/alert_create_for_subscription_params.rb +3 -3
- data/lib/orb/models/alert_list_params.rb +5 -5
- data/lib/orb/models/alert_update_params.rb +3 -3
- data/lib/orb/models/amount_discount.rb +1 -1
- data/lib/orb/models/billable_metric.rb +7 -7
- data/lib/orb/models/coupon.rb +7 -7
- data/lib/orb/models/coupon_create_params.rb +2 -2
- data/lib/orb/models/coupon_list_params.rb +3 -3
- data/lib/orb/models/coupons/subscription_list_params.rb +1 -1
- data/lib/orb/models/credit_note.rb +1 -1
- data/lib/orb/models/credit_note_list_params.rb +5 -5
- data/lib/orb/models/customer.rb +237 -237
- data/lib/orb/models/customer_create_params.rb +229 -229
- data/lib/orb/models/customer_list_params.rb +5 -5
- data/lib/orb/models/customer_update_by_external_id_params.rb +230 -230
- data/lib/orb/models/customer_update_params.rb +230 -230
- data/lib/orb/models/customers/balance_transaction_create_response.rb +2 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +5 -5
- data/lib/orb/models/customers/balance_transaction_list_response.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +6 -6
- data/lib/orb/models/customers/cost_list_params.rb +6 -6
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +3 -3
- data/lib/orb/models/customers/credit_list_params.rb +3 -3
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +5 -5
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_list_params.rb +5 -5
- data/lib/orb/models/customers/credits/ledger_list_response.rb +22 -22
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -10
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +9 -9
- data/lib/orb/models/customers/credits/top_up_create_params.rb +10 -10
- data/lib/orb/models/customers/credits/top_up_create_response.rb +9 -9
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +9 -9
- data/lib/orb/models/customers/credits/top_up_list_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +9 -9
- data/lib/orb/models/dimensional_price_group.rb +7 -7
- data/lib/orb/models/dimensional_price_group_create_params.rb +2 -2
- data/lib/orb/models/dimensional_price_group_list_params.rb +1 -1
- data/lib/orb/models/evaluate_price_group.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +8 -8
- data/lib/orb/models/event_ingest_response.rb +4 -4
- data/lib/orb/models/event_search_params.rb +5 -5
- data/lib/orb/models/event_search_response.rb +9 -9
- data/lib/orb/models/event_update_params.rb +4 -4
- data/lib/orb/models/events/backfill_close_response.rb +8 -8
- data/lib/orb/models/events/backfill_create_params.rb +12 -12
- data/lib/orb/models/events/backfill_create_response.rb +8 -8
- data/lib/orb/models/events/backfill_fetch_response.rb +8 -8
- data/lib/orb/models/events/backfill_list_params.rb +1 -1
- data/lib/orb/models/events/backfill_list_response.rb +8 -8
- data/lib/orb/models/events/backfill_revert_response.rb +8 -8
- data/lib/orb/models/events/event_volumes.rb +1 -1
- data/lib/orb/models/events/volume_list_params.rb +7 -7
- data/lib/orb/models/invoice.rb +278 -278
- data/lib/orb/models/invoice_create_params.rb +13 -12
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +274 -274
- data/lib/orb/models/invoice_issue_params.rb +5 -5
- data/lib/orb/models/invoice_line_item_create_params.rb +1 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +32 -32
- data/lib/orb/models/invoice_list_params.rb +13 -13
- data/lib/orb/models/invoice_update_params.rb +2 -2
- data/lib/orb/models/item.rb +2 -2
- data/lib/orb/models/item_list_params.rb +1 -1
- data/lib/orb/models/metric_create_params.rb +2 -2
- data/lib/orb/models/metric_list_params.rb +5 -5
- data/lib/orb/models/metric_update_params.rb +2 -2
- data/lib/orb/models/pagination_metadata.rb +1 -1
- data/lib/orb/models/percentage_discount.rb +2 -2
- data/lib/orb/models/plan.rb +40 -40
- data/lib/orb/models/plan_create_params.rb +292 -292
- data/lib/orb/models/plan_list_params.rb +5 -5
- data/lib/orb/models/plan_update_params.rb +4 -4
- data/lib/orb/models/plans/external_plan_id_update_params.rb +4 -4
- data/lib/orb/models/price.rb +186 -186
- data/lib/orb/models/price_create_params.rb +21 -21
- data/lib/orb/models/price_evaluate_params.rb +4 -4
- data/lib/orb/models/price_list_params.rb +1 -1
- data/lib/orb/models/price_update_params.rb +2 -2
- data/lib/orb/models/prices/external_price_id_update_params.rb +2 -2
- data/lib/orb/models/subscription.rb +120 -93
- data/lib/orb/models/subscription_cancel_params.rb +4 -4
- data/lib/orb/models/subscription_cancel_response.rb +156 -78
- data/lib/orb/models/subscription_change_apply_params.rb +33 -0
- data/lib/orb/models/subscription_change_apply_response.rb +1372 -0
- data/lib/orb/models/subscription_change_cancel_params.rb +19 -0
- data/lib/orb/models/subscription_change_cancel_response.rb +1372 -0
- data/lib/orb/models/subscription_change_retrieve_params.rb +19 -0
- data/lib/orb/models/subscription_change_retrieve_response.rb +1372 -0
- data/lib/orb/models/subscription_create_params.rb +705 -705
- data/lib/orb/models/subscription_create_response.rb +156 -78
- data/lib/orb/models/subscription_fetch_costs_params.rb +6 -6
- data/lib/orb/models/subscription_fetch_schedule_params.rb +5 -5
- data/lib/orb/models/subscription_fetch_schedule_response.rb +2 -2
- data/lib/orb/models/subscription_fetch_usage_params.rb +8 -8
- data/lib/orb/models/subscription_list_params.rb +5 -5
- data/lib/orb/models/subscription_price_intervals_params.rb +358 -358
- data/lib/orb/models/subscription_price_intervals_response.rb +158 -78
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +715 -715
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +158 -78
- data/lib/orb/models/subscription_trigger_phase_params.rb +4 -4
- data/lib/orb/models/subscription_trigger_phase_response.rb +158 -78
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +158 -78
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +159 -79
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +158 -78
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +9 -9
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +158 -78
- data/lib/orb/models/subscription_update_params.rb +11 -11
- data/lib/orb/models/subscription_update_trial_params.rb +4 -4
- data/lib/orb/models/subscription_update_trial_response.rb +158 -78
- data/lib/orb/models/trial_discount.rb +1 -1
- data/lib/orb/models/usage_discount.rb +2 -2
- data/lib/orb/request_options.rb +7 -7
- data/lib/orb/resources/alerts.rb +40 -35
- data/lib/orb/resources/coupons/subscriptions.rb +3 -3
- data/lib/orb/resources/coupons.rb +9 -9
- data/lib/orb/resources/credit_notes.rb +10 -5
- data/lib/orb/resources/customers/balance_transactions.rb +28 -23
- data/lib/orb/resources/customers/costs.rb +232 -232
- data/lib/orb/resources/customers/credits/ledger.rb +348 -338
- data/lib/orb/resources/customers/credits/top_ups.rb +12 -12
- data/lib/orb/resources/customers/credits.rb +8 -8
- data/lib/orb/resources/customers.rb +61 -56
- data/lib/orb/resources/dimensional_price_groups.rb +6 -6
- data/lib/orb/resources/events/backfills.rb +49 -49
- data/lib/orb/resources/events/volume.rb +10 -10
- data/lib/orb/resources/events.rb +295 -295
- data/lib/orb/resources/invoice_line_items.rb +1 -1
- data/lib/orb/resources/invoices.rb +40 -31
- data/lib/orb/resources/items.rb +1 -1
- data/lib/orb/resources/metrics.rb +13 -8
- data/lib/orb/resources/plans/external_plan_id.rb +14 -14
- data/lib/orb/resources/plans.rb +24 -19
- data/lib/orb/resources/prices/external_price_id.rb +4 -4
- data/lib/orb/resources/prices.rb +30 -30
- data/lib/orb/resources/subscription_changes.rb +87 -0
- data/lib/orb/resources/subscriptions.rb +817 -807
- data/lib/orb/resources/top_level.rb +4 -4
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +8 -1
- data/rbi/lib/orb/client.rbi +5 -4
- data/rbi/lib/orb/errors.rbi +3 -6
- data/rbi/lib/orb/internal/page.rbi +3 -6
- data/rbi/lib/orb/internal/transport/base_client.rbi +13 -27
- data/rbi/lib/orb/internal/transport/pooled_net_requester.rbi +7 -13
- data/rbi/lib/orb/internal/type/array_of.rbi +10 -18
- data/rbi/lib/orb/internal/type/base_model.rbi +45 -64
- data/rbi/lib/orb/internal/type/base_page.rbi +5 -10
- data/rbi/lib/orb/internal/type/{boolean_model.rbi → boolean.rbi} +5 -9
- data/rbi/lib/orb/internal/type/converter.rbi +25 -31
- data/rbi/lib/orb/internal/type/enum.rbi +14 -20
- data/rbi/lib/orb/internal/type/hash_of.rbi +8 -16
- data/rbi/lib/orb/internal/type/request_parameters.rbi +1 -2
- data/rbi/lib/orb/internal/type/union.rbi +10 -20
- data/rbi/lib/orb/internal/type/unknown.rbi +4 -8
- data/rbi/lib/orb/internal/util.rbi +40 -72
- data/rbi/lib/orb/internal.rbi +1 -1
- data/rbi/lib/orb/models/alert.rbi +21 -33
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_disable_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_enable_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_list_params.rbi +3 -6
- data/rbi/lib/orb/models/alert_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_update_params.rbi +7 -11
- data/rbi/lib/orb/models/amount_discount.rbi +4 -7
- data/rbi/lib/orb/models/billable_metric.rbi +10 -13
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -2
- data/rbi/lib/orb/models/coupon.rbi +9 -11
- data/rbi/lib/orb/models/coupon_archive_params.rbi +2 -4
- data/rbi/lib/orb/models/coupon_create_params.rbi +8 -14
- data/rbi/lib/orb/models/coupon_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/coupon_list_params.rbi +3 -4
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +3 -5
- data/rbi/lib/orb/models/credit_note.rbi +22 -45
- data/rbi/lib/orb/models/credit_note_create_params.rbi +5 -10
- data/rbi/lib/orb/models/credit_note_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customer.rbi +256 -281
- data/rbi/lib/orb/models/customer_create_params.rbi +251 -276
- data/rbi/lib/orb/models/customer_delete_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +252 -277
- data/rbi/lib/orb/models/customer_update_params.rbi +252 -277
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +3 -6
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +10 -19
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +10 -19
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +8 -10
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +6 -12
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +8 -10
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +6 -12
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +3 -4
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +2 -4
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +3 -4
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +26 -33
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +79 -136
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +26 -33
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +78 -135
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +5 -10
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +79 -136
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +5 -10
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +74 -131
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +13 -19
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +13 -19
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +3 -5
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +3 -5
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +12 -18
- data/rbi/lib/orb/models/dimensional_price_group.rbi +8 -9
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -7
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +3 -5
- data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/dimensional_price_groups.rbi +2 -4
- data/rbi/lib/orb/models/discount.rbi +1 -2
- data/rbi/lib/orb/models/evaluate_price_group.rbi +3 -6
- data/rbi/lib/orb/models/event_deprecate_params.rbi +2 -4
- data/rbi/lib/orb/models/event_deprecate_response.rbi +2 -4
- data/rbi/lib/orb/models/event_ingest_params.rbi +10 -13
- data/rbi/lib/orb/models/event_ingest_response.rbi +10 -16
- data/rbi/lib/orb/models/event_search_params.rbi +7 -9
- data/rbi/lib/orb/models/event_search_response.rbi +11 -14
- data/rbi/lib/orb/models/event_update_params.rbi +5 -6
- data/rbi/lib/orb/models/event_update_response.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_close_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +13 -16
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +3 -5
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_revert_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +10 -14
- data/rbi/lib/orb/models/events/event_volumes.rbi +5 -9
- data/rbi/lib/orb/models/events/volume_list_params.rbi +9 -11
- data/rbi/lib/orb/models/invoice.rbi +388 -465
- data/rbi/lib/orb/models/invoice_create_params.rbi +19 -26
- data/rbi/lib/orb/models/invoice_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +381 -460
- data/rbi/lib/orb/models/invoice_issue_params.rbi +6 -8
- data/rbi/lib/orb/models/invoice_level_discount.rbi +1 -2
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +3 -5
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +101 -143
- data/rbi/lib/orb/models/invoice_list_params.rbi +8 -13
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_pay_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_update_params.rbi +4 -6
- data/rbi/lib/orb/models/invoice_void_params.rbi +2 -4
- data/rbi/lib/orb/models/item.rbi +7 -12
- data/rbi/lib/orb/models/item_create_params.rbi +2 -4
- data/rbi/lib/orb/models/item_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/item_list_params.rbi +3 -5
- data/rbi/lib/orb/models/item_update_params.rbi +5 -10
- data/rbi/lib/orb/models/metric_create_params.rbi +4 -6
- data/rbi/lib/orb/models/metric_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/metric_list_params.rbi +3 -6
- data/rbi/lib/orb/models/metric_update_params.rbi +4 -6
- data/rbi/lib/orb/models/pagination_metadata.rbi +2 -4
- data/rbi/lib/orb/models/percentage_discount.rbi +5 -8
- data/rbi/lib/orb/models/plan.rbi +180 -219
- data/rbi/lib/orb/models/plan_create_params.rbi +670 -951
- data/rbi/lib/orb/models/plan_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/plan_list_params.rbi +4 -8
- data/rbi/lib/orb/models/plan_update_params.rbi +6 -8
- data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +6 -8
- data/rbi/lib/orb/models/price.rbi +827 -1494
- data/rbi/lib/orb/models/price_create_params.rbi +60 -101
- data/rbi/lib/orb/models/price_evaluate_params.rbi +6 -9
- data/rbi/lib/orb/models/price_evaluate_response.rbi +2 -4
- data/rbi/lib/orb/models/price_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/price_list_params.rbi +3 -5
- data/rbi/lib/orb/models/price_update_params.rbi +4 -6
- data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +4 -6
- data/rbi/lib/orb/models/subscription.rbi +167 -187
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +5 -7
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_change_apply_params.rbi +40 -0
- data/rbi/lib/orb/models/subscription_change_apply_response.rbi +1554 -0
- data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +18 -0
- data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +1565 -0
- data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +18 -0
- data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +1581 -0
- data/rbi/lib/orb/models/subscription_create_params.rbi +1372 -1968
- data/rbi/lib/orb/models/subscription_create_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +8 -10
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +6 -12
- data/rbi/lib/orb/models/subscription_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -6
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +6 -10
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +12 -17
- data/rbi/lib/orb/models/subscription_list_params.rbi +4 -8
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +772 -1124
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +228 -178
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +1396 -1993
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +5 -7
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +265 -199
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +264 -198
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -15
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_update_params.rbi +12 -15
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +6 -9
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_usage.rbi +24 -43
- data/rbi/lib/orb/models/subscriptions.rbi +2 -4
- data/rbi/lib/orb/models/top_level_ping_params.rbi +2 -4
- data/rbi/lib/orb/models/top_level_ping_response.rbi +2 -4
- data/rbi/lib/orb/models/trial_discount.rbi +4 -8
- data/rbi/lib/orb/models/usage_discount.rbi +5 -8
- data/rbi/lib/orb/request_options.rbi +9 -11
- data/rbi/lib/orb/resources/alerts.rbi +44 -60
- data/rbi/lib/orb/resources/coupons/subscriptions.rbi +6 -9
- data/rbi/lib/orb/resources/coupons.rbi +18 -25
- data/rbi/lib/orb/resources/credit_notes.rbi +9 -15
- data/rbi/lib/orb/resources/customers/balance_transactions.rbi +26 -31
- data/rbi/lib/orb/resources/customers/costs.rbi +241 -246
- data/rbi/lib/orb/resources/customers/credits/ledger.rbi +387 -396
- data/rbi/lib/orb/resources/customers/credits/top_ups.rbi +29 -40
- data/rbi/lib/orb/resources/customers/credits.rbi +15 -20
- data/rbi/lib/orb/resources/customers.rbi +407 -417
- data/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +2 -4
- data/rbi/lib/orb/resources/dimensional_price_groups.rbi +13 -19
- data/rbi/lib/orb/resources/events/backfills.rbi +61 -69
- data/rbi/lib/orb/resources/events/volume.rbi +19 -22
- data/rbi/lib/orb/resources/events.rbi +311 -319
- data/rbi/lib/orb/resources/invoice_line_items.rbi +4 -7
- data/rbi/lib/orb/resources/invoices.rbi +62 -76
- data/rbi/lib/orb/resources/items.rbi +7 -14
- data/rbi/lib/orb/resources/metrics.rbi +17 -25
- data/rbi/lib/orb/resources/plans/external_plan_id.rbi +21 -25
- data/rbi/lib/orb/resources/plans.rbi +63 -71
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +9 -13
- data/rbi/lib/orb/resources/prices.rbi +77 -87
- data/rbi/lib/orb/resources/subscription_changes.rbi +61 -0
- data/rbi/lib/orb/resources/subscriptions.rbi +933 -963
- data/rbi/lib/orb/resources/top_level.rbi +6 -8
- data/rbi/lib/orb/version.rbi +1 -1
- data/sig/orb/client.rbs +2 -0
- data/sig/orb/internal/type/array_of.rbs +2 -2
- data/sig/orb/internal/type/{boolean_model.rbs → boolean.rbs} +1 -1
- data/sig/orb/internal/util.rbs +5 -5
- data/sig/orb/models/subscription.rbs +14 -0
- data/sig/orb/models/subscription_cancel_response.rbs +47 -2
- data/sig/orb/models/subscription_change_apply_params.rbs +24 -0
- data/sig/orb/models/subscription_change_apply_response.rbs +784 -0
- data/sig/orb/models/subscription_change_cancel_params.rbs +15 -0
- data/sig/orb/models/subscription_change_cancel_response.rbs +784 -0
- data/sig/orb/models/subscription_change_retrieve_params.rbs +15 -0
- data/sig/orb/models/subscription_change_retrieve_response.rbs +784 -0
- data/sig/orb/models/subscription_create_response.rbs +47 -2
- data/sig/orb/models/subscription_price_intervals_response.rbs +47 -2
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +47 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +47 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +47 -2
- data/sig/orb/models/subscription_update_trial_response.rbs +47 -2
- data/sig/orb/resources/customers.rbs +2 -2
- data/sig/orb/resources/subscription_changes.rbs +24 -0
- data/sig/orb/version.rbs +1 -1
- metadata +26 -5
|
@@ -7,7 +7,7 @@ module Orb
|
|
|
7
7
|
attr_accessor :id
|
|
8
8
|
|
|
9
9
|
# This is the final amount required to be charged to the customer and reflects the
|
|
10
|
-
#
|
|
10
|
+
# application of the customer balance to the `total` of the invoice.
|
|
11
11
|
sig { returns(String) }
|
|
12
12
|
attr_accessor :amount_due
|
|
13
13
|
|
|
@@ -48,119 +48,121 @@ module Orb
|
|
|
48
48
|
attr_accessor :customer_balance_transactions
|
|
49
49
|
|
|
50
50
|
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
|
51
|
-
#
|
|
51
|
+
# added to the headers of invoices.
|
|
52
52
|
#
|
|
53
|
-
#
|
|
53
|
+
# ### Supported Tax ID Countries and Types
|
|
54
54
|
#
|
|
55
|
-
#
|
|
56
|
-
#
|
|
57
|
-
#
|
|
58
|
-
#
|
|
59
|
-
#
|
|
60
|
-
#
|
|
61
|
-
#
|
|
62
|
-
#
|
|
63
|
-
#
|
|
64
|
-
#
|
|
65
|
-
#
|
|
66
|
-
#
|
|
67
|
-
#
|
|
68
|
-
#
|
|
69
|
-
#
|
|
70
|
-
#
|
|
71
|
-
#
|
|
72
|
-
#
|
|
73
|
-
#
|
|
74
|
-
#
|
|
75
|
-
#
|
|
76
|
-
#
|
|
77
|
-
#
|
|
78
|
-
#
|
|
79
|
-
#
|
|
80
|
-
#
|
|
81
|
-
#
|
|
82
|
-
#
|
|
83
|
-
#
|
|
84
|
-
#
|
|
85
|
-
#
|
|
86
|
-
#
|
|
87
|
-
#
|
|
88
|
-
#
|
|
89
|
-
#
|
|
90
|
-
#
|
|
91
|
-
#
|
|
92
|
-
#
|
|
93
|
-
#
|
|
94
|
-
#
|
|
95
|
-
#
|
|
96
|
-
#
|
|
97
|
-
#
|
|
98
|
-
#
|
|
99
|
-
#
|
|
100
|
-
#
|
|
101
|
-
#
|
|
102
|
-
#
|
|
103
|
-
#
|
|
104
|
-
#
|
|
105
|
-
#
|
|
106
|
-
#
|
|
107
|
-
#
|
|
108
|
-
#
|
|
109
|
-
#
|
|
110
|
-
#
|
|
111
|
-
#
|
|
112
|
-
#
|
|
113
|
-
#
|
|
114
|
-
#
|
|
115
|
-
#
|
|
116
|
-
#
|
|
117
|
-
#
|
|
118
|
-
#
|
|
119
|
-
#
|
|
120
|
-
#
|
|
121
|
-
#
|
|
122
|
-
#
|
|
123
|
-
#
|
|
124
|
-
#
|
|
125
|
-
#
|
|
126
|
-
#
|
|
127
|
-
#
|
|
128
|
-
#
|
|
129
|
-
#
|
|
130
|
-
#
|
|
131
|
-
#
|
|
132
|
-
#
|
|
133
|
-
#
|
|
134
|
-
#
|
|
135
|
-
#
|
|
136
|
-
#
|
|
137
|
-
#
|
|
138
|
-
#
|
|
139
|
-
#
|
|
140
|
-
#
|
|
141
|
-
#
|
|
142
|
-
#
|
|
143
|
-
#
|
|
144
|
-
#
|
|
145
|
-
#
|
|
146
|
-
#
|
|
147
|
-
#
|
|
148
|
-
#
|
|
149
|
-
#
|
|
150
|
-
#
|
|
151
|
-
#
|
|
152
|
-
#
|
|
153
|
-
#
|
|
154
|
-
#
|
|
55
|
+
# | Country | Type | Description |
|
|
56
|
+
# | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
|
57
|
+
# | Andorra | `ad_nrt` | Andorran NRT Number |
|
|
58
|
+
# | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
|
59
|
+
# | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
|
60
|
+
# | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
|
61
|
+
# | Austria | `eu_vat` | European VAT Number |
|
|
62
|
+
# | Bahrain | `bh_vat` | Bahraini VAT Number |
|
|
63
|
+
# | Belgium | `eu_vat` | European VAT Number |
|
|
64
|
+
# | Bolivia | `bo_tin` | Bolivian Tax ID |
|
|
65
|
+
# | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
|
66
|
+
# | Brazil | `br_cpf` | Brazilian CPF Number |
|
|
67
|
+
# | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
|
68
|
+
# | Bulgaria | `eu_vat` | European VAT Number |
|
|
69
|
+
# | Canada | `ca_bn` | Canadian BN |
|
|
70
|
+
# | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
|
71
|
+
# | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
|
72
|
+
# | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
|
73
|
+
# | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
|
74
|
+
# | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
|
75
|
+
# | Chile | `cl_tin` | Chilean TIN |
|
|
76
|
+
# | China | `cn_tin` | Chinese Tax ID |
|
|
77
|
+
# | Colombia | `co_nit` | Colombian NIT Number |
|
|
78
|
+
# | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
|
79
|
+
# | Croatia | `eu_vat` | European VAT Number |
|
|
80
|
+
# | Cyprus | `eu_vat` | European VAT Number |
|
|
81
|
+
# | Czech Republic | `eu_vat` | European VAT Number |
|
|
82
|
+
# | Denmark | `eu_vat` | European VAT Number |
|
|
83
|
+
# | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
|
84
|
+
# | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
|
85
|
+
# | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
|
86
|
+
# | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
|
87
|
+
# | Estonia | `eu_vat` | European VAT Number |
|
|
88
|
+
# | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
|
89
|
+
# | Finland | `eu_vat` | European VAT Number |
|
|
90
|
+
# | France | `eu_vat` | European VAT Number |
|
|
91
|
+
# | Georgia | `ge_vat` | Georgian VAT |
|
|
92
|
+
# | Germany | `eu_vat` | European VAT Number |
|
|
93
|
+
# | Greece | `eu_vat` | European VAT Number |
|
|
94
|
+
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
|
95
|
+
# | Hungary | `eu_vat` | European VAT Number |
|
|
96
|
+
# | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
|
97
|
+
# | Iceland | `is_vat` | Icelandic VAT |
|
|
98
|
+
# | India | `in_gst` | Indian GST Number |
|
|
99
|
+
# | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
|
100
|
+
# | Ireland | `eu_vat` | European VAT Number |
|
|
101
|
+
# | Israel | `il_vat` | Israel VAT |
|
|
102
|
+
# | Italy | `eu_vat` | European VAT Number |
|
|
103
|
+
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
|
104
|
+
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
|
105
|
+
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
|
106
|
+
# | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
|
107
|
+
# | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
|
108
|
+
# | Latvia | `eu_vat` | European VAT Number |
|
|
109
|
+
# | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
|
110
|
+
# | Lithuania | `eu_vat` | European VAT Number |
|
|
111
|
+
# | Luxembourg | `eu_vat` | European VAT Number |
|
|
112
|
+
# | Malaysia | `my_frp` | Malaysian FRP Number |
|
|
113
|
+
# | Malaysia | `my_itn` | Malaysian ITN |
|
|
114
|
+
# | Malaysia | `my_sst` | Malaysian SST Number |
|
|
115
|
+
# | Malta | `eu_vat ` | European VAT Number |
|
|
116
|
+
# | Mexico | `mx_rfc` | Mexican RFC Number |
|
|
117
|
+
# | Netherlands | `eu_vat` | European VAT Number |
|
|
118
|
+
# | New Zealand | `nz_gst` | New Zealand GST Number |
|
|
119
|
+
# | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
|
120
|
+
# | Norway | `no_vat` | Norwegian VAT Number |
|
|
121
|
+
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
|
122
|
+
# | Oman | `om_vat` | Omani VAT Number |
|
|
123
|
+
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
|
124
|
+
# | Philippines | `ph_tin ` | Philippines Tax Identification Number |
|
|
125
|
+
# | Poland | `eu_vat` | European VAT Number |
|
|
126
|
+
# | Portugal | `eu_vat` | European VAT Number |
|
|
127
|
+
# | Romania | `eu_vat` | European VAT Number |
|
|
128
|
+
# | Romania | `ro_tin` | Romanian Tax ID Number |
|
|
129
|
+
# | Russia | `ru_inn` | Russian INN |
|
|
130
|
+
# | Russia | `ru_kpp` | Russian KPP |
|
|
131
|
+
# | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
|
132
|
+
# | Serbia | `rs_pib` | Serbian PIB Number |
|
|
133
|
+
# | Singapore | `sg_gst` | Singaporean GST |
|
|
134
|
+
# | Singapore | `sg_uen` | Singaporean UEN |
|
|
135
|
+
# | Slovakia | `eu_vat` | European VAT Number |
|
|
136
|
+
# | Slovenia | `eu_vat` | European VAT Number |
|
|
137
|
+
# | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
|
138
|
+
# | South Africa | `za_vat` | South African VAT Number |
|
|
139
|
+
# | South Korea | `kr_brn` | Korean BRN |
|
|
140
|
+
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
|
141
|
+
# | Spain | `eu_vat` | European VAT Number |
|
|
142
|
+
# | Sweden | `eu_vat` | European VAT Number |
|
|
143
|
+
# | Switzerland | `ch_vat` | Switzerland VAT Number |
|
|
144
|
+
# | Taiwan | `tw_vat` | Taiwanese VAT |
|
|
145
|
+
# | Thailand | `th_vat` | Thai VAT |
|
|
146
|
+
# | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
|
147
|
+
# | Ukraine | `ua_vat` | Ukrainian VAT |
|
|
148
|
+
# | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
|
149
|
+
# | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
|
|
150
|
+
# | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
|
151
|
+
# | United States | `us_ein` | United States EIN |
|
|
152
|
+
# | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
|
153
|
+
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
|
154
|
+
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
|
155
155
|
sig { returns(T.nilable(Orb::Models::Invoice::CustomerTaxID)) }
|
|
156
156
|
attr_reader :customer_tax_id
|
|
157
157
|
|
|
158
|
-
sig
|
|
158
|
+
sig do
|
|
159
|
+
params(customer_tax_id: T.nilable(T.any(Orb::Models::Invoice::CustomerTaxID, Orb::Internal::AnyHash))).void
|
|
160
|
+
end
|
|
159
161
|
attr_writer :customer_tax_id
|
|
160
162
|
|
|
161
163
|
# This field is deprecated in favor of `discounts`. If a `discounts` list is
|
|
162
|
-
#
|
|
163
|
-
#
|
|
164
|
+
# provided, the first discount in the list will be returned. If the list is empty,
|
|
165
|
+
# `None` will be returned.
|
|
164
166
|
sig { returns(T.anything) }
|
|
165
167
|
attr_accessor :discount
|
|
166
168
|
|
|
@@ -172,18 +174,18 @@ module Orb
|
|
|
172
174
|
attr_accessor :discounts
|
|
173
175
|
|
|
174
176
|
# When the invoice payment is due. The due date is null if the invoice is not yet
|
|
175
|
-
#
|
|
177
|
+
# finalized.
|
|
176
178
|
sig { returns(T.nilable(Time)) }
|
|
177
179
|
attr_accessor :due_date
|
|
178
180
|
|
|
179
181
|
# If the invoice has a status of `draft`, this will be the time that the invoice
|
|
180
|
-
#
|
|
181
|
-
#
|
|
182
|
+
# will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is
|
|
183
|
+
# true, the invoice will automatically begin issuing at this time.
|
|
182
184
|
sig { returns(T.nilable(Time)) }
|
|
183
185
|
attr_accessor :eligible_to_issue_at
|
|
184
186
|
|
|
185
187
|
# A URL for the customer-facing invoice portal. This URL expires 30 days after the
|
|
186
|
-
#
|
|
188
|
+
# invoice's due date, or 60 days after being re-generated through the UI.
|
|
187
189
|
sig { returns(T.nilable(String)) }
|
|
188
190
|
attr_accessor :hosted_invoice_url
|
|
189
191
|
|
|
@@ -192,8 +194,8 @@ module Orb
|
|
|
192
194
|
attr_accessor :invoice_date
|
|
193
195
|
|
|
194
196
|
# Automatically generated invoice number to help track and reconcile invoices.
|
|
195
|
-
#
|
|
196
|
-
#
|
|
197
|
+
# Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per
|
|
198
|
+
# account or customer.
|
|
197
199
|
sig { returns(String) }
|
|
198
200
|
attr_accessor :invoice_number
|
|
199
201
|
|
|
@@ -205,12 +207,12 @@ module Orb
|
|
|
205
207
|
attr_accessor :invoice_source
|
|
206
208
|
|
|
207
209
|
# If the invoice failed to issue, this will be the last time it failed to issue
|
|
208
|
-
#
|
|
210
|
+
# (even if it is now in a different state.)
|
|
209
211
|
sig { returns(T.nilable(Time)) }
|
|
210
212
|
attr_accessor :issue_failed_at
|
|
211
213
|
|
|
212
214
|
# If the invoice has been issued, this will be the time it transitioned to
|
|
213
|
-
#
|
|
215
|
+
# `issued` (even if it is now in a different state.)
|
|
214
216
|
sig { returns(T.nilable(Time)) }
|
|
215
217
|
attr_accessor :issued_at
|
|
216
218
|
|
|
@@ -232,9 +234,9 @@ module Orb
|
|
|
232
234
|
attr_accessor :memo
|
|
233
235
|
|
|
234
236
|
# User specified key-value pairs for the resource. If not present, this defaults
|
|
235
|
-
#
|
|
236
|
-
#
|
|
237
|
-
#
|
|
237
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
|
238
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
|
239
|
+
# `null`.
|
|
238
240
|
sig { returns(T::Hash[Symbol, String]) }
|
|
239
241
|
attr_accessor :metadata
|
|
240
242
|
|
|
@@ -248,7 +250,7 @@ module Orb
|
|
|
248
250
|
attr_accessor :minimum_amount
|
|
249
251
|
|
|
250
252
|
# If the invoice has a status of `paid`, this gives a timestamp when the invoice
|
|
251
|
-
#
|
|
253
|
+
# was paid.
|
|
252
254
|
sig { returns(T.nilable(Time)) }
|
|
253
255
|
attr_accessor :paid_at
|
|
254
256
|
|
|
@@ -257,18 +259,18 @@ module Orb
|
|
|
257
259
|
attr_accessor :payment_attempts
|
|
258
260
|
|
|
259
261
|
# If payment was attempted on this invoice but failed, this will be the time of
|
|
260
|
-
#
|
|
262
|
+
# the most recent attempt.
|
|
261
263
|
sig { returns(T.nilable(Time)) }
|
|
262
264
|
attr_accessor :payment_failed_at
|
|
263
265
|
|
|
264
266
|
# If payment was attempted on this invoice, this will be the start time of the
|
|
265
|
-
#
|
|
266
|
-
#
|
|
267
|
+
# most recent attempt. This field is especially useful for delayed-notification
|
|
268
|
+
# payment mechanisms (like bank transfers), where payment can take 3 days or more.
|
|
267
269
|
sig { returns(T.nilable(Time)) }
|
|
268
270
|
attr_accessor :payment_started_at
|
|
269
271
|
|
|
270
272
|
# If the invoice is in draft, this timestamp will reflect when the invoice is
|
|
271
|
-
#
|
|
273
|
+
# scheduled to be issued.
|
|
272
274
|
sig { returns(T.nilable(Time)) }
|
|
273
275
|
attr_accessor :scheduled_issue_at
|
|
274
276
|
|
|
@@ -295,8 +297,8 @@ module Orb
|
|
|
295
297
|
attr_accessor :subtotal
|
|
296
298
|
|
|
297
299
|
# If the invoice failed to sync, this will be the last time an external invoicing
|
|
298
|
-
#
|
|
299
|
-
#
|
|
300
|
+
# provider sync was attempted. This field will always be `null` for invoices using
|
|
301
|
+
# Orb Invoicing.
|
|
300
302
|
sig { returns(T.nilable(Time)) }
|
|
301
303
|
attr_accessor :sync_failed_at
|
|
302
304
|
|
|
@@ -305,20 +307,20 @@ module Orb
|
|
|
305
307
|
attr_accessor :total
|
|
306
308
|
|
|
307
309
|
# If the invoice has a status of `void`, this gives a timestamp when the invoice
|
|
308
|
-
#
|
|
310
|
+
# was voided.
|
|
309
311
|
sig { returns(T.nilable(Time)) }
|
|
310
312
|
attr_accessor :voided_at
|
|
311
313
|
|
|
312
314
|
# This is true if the invoice will be automatically issued in the future, and
|
|
313
|
-
#
|
|
315
|
+
# false otherwise.
|
|
314
316
|
sig { returns(T::Boolean) }
|
|
315
317
|
attr_accessor :will_auto_issue
|
|
316
318
|
|
|
317
319
|
# An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
|
|
318
|
-
#
|
|
319
|
-
#
|
|
320
|
-
#
|
|
321
|
-
#
|
|
320
|
+
# representing the request for payment for a single subscription. This includes a
|
|
321
|
+
# set of line items, which correspond to prices in the subscription's plan and can
|
|
322
|
+
# represent fixed recurring fees or usage-based fees. They are generated at the
|
|
323
|
+
# end of a billing period, or as the result of an action, such as a cancellation.
|
|
322
324
|
sig do
|
|
323
325
|
params(
|
|
324
326
|
id: String,
|
|
@@ -333,12 +335,12 @@ module Orb
|
|
|
333
335
|
customer_tax_id: T.nilable(T.any(Orb::Models::Invoice::CustomerTaxID, Orb::Internal::AnyHash)),
|
|
334
336
|
discount: T.anything,
|
|
335
337
|
discounts: T::Array[
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
338
|
+
T.any(
|
|
339
|
+
Orb::Models::PercentageDiscount,
|
|
340
|
+
Orb::Internal::AnyHash,
|
|
341
|
+
Orb::Models::AmountDiscount,
|
|
342
|
+
Orb::Models::TrialDiscount
|
|
343
|
+
)
|
|
342
344
|
],
|
|
343
345
|
due_date: T.nilable(Time),
|
|
344
346
|
eligible_to_issue_at: T.nilable(Time),
|
|
@@ -414,9 +416,7 @@ module Orb
|
|
|
414
416
|
total:,
|
|
415
417
|
voided_at:,
|
|
416
418
|
will_auto_issue:
|
|
417
|
-
)
|
|
418
|
-
end
|
|
419
|
-
|
|
419
|
+
); end
|
|
420
420
|
sig do
|
|
421
421
|
override
|
|
422
422
|
.returns(
|
|
@@ -465,8 +465,7 @@ module Orb
|
|
|
465
465
|
}
|
|
466
466
|
)
|
|
467
467
|
end
|
|
468
|
-
def to_hash
|
|
469
|
-
end
|
|
468
|
+
def to_hash; end
|
|
470
469
|
|
|
471
470
|
class AutoCollection < Orb::Internal::Type::BaseModel
|
|
472
471
|
# True only if auto-collection is enabled for this invoice.
|
|
@@ -474,8 +473,8 @@ module Orb
|
|
|
474
473
|
attr_accessor :enabled
|
|
475
474
|
|
|
476
475
|
# If the invoice is scheduled for auto-collection, this field will reflect when
|
|
477
|
-
#
|
|
478
|
-
#
|
|
476
|
+
# the next attempt will occur. If dunning has been exhausted, or auto-collection
|
|
477
|
+
# is not enabled for this invoice, this field will be `null`.
|
|
479
478
|
sig { returns(T.nilable(Time)) }
|
|
480
479
|
attr_accessor :next_attempt_at
|
|
481
480
|
|
|
@@ -484,11 +483,11 @@ module Orb
|
|
|
484
483
|
attr_accessor :num_attempts
|
|
485
484
|
|
|
486
485
|
# If Orb has ever attempted payment auto-collection for this invoice, this field
|
|
487
|
-
#
|
|
488
|
-
#
|
|
489
|
-
#
|
|
490
|
-
#
|
|
491
|
-
#
|
|
486
|
+
# will reflect when that attempt occurred. In conjunction with `next_attempt_at`,
|
|
487
|
+
# this can be used to tell whether the invoice is currently in dunning (that is,
|
|
488
|
+
# `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or
|
|
489
|
+
# if dunning has been exhausted (`previously_attempted_at` is non-null, but
|
|
490
|
+
# `next_attempt_time` is null).
|
|
492
491
|
sig { returns(T.nilable(Time)) }
|
|
493
492
|
attr_accessor :previously_attempted_at
|
|
494
493
|
|
|
@@ -501,8 +500,7 @@ module Orb
|
|
|
501
500
|
)
|
|
502
501
|
.returns(T.attached_class)
|
|
503
502
|
end
|
|
504
|
-
def self.new(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:)
|
|
505
|
-
end
|
|
503
|
+
def self.new(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:); end
|
|
506
504
|
|
|
507
505
|
sig do
|
|
508
506
|
override
|
|
@@ -515,8 +513,7 @@ module Orb
|
|
|
515
513
|
}
|
|
516
514
|
)
|
|
517
515
|
end
|
|
518
|
-
def to_hash
|
|
519
|
-
end
|
|
516
|
+
def to_hash; end
|
|
520
517
|
end
|
|
521
518
|
|
|
522
519
|
class BillingAddress < Orb::Internal::Type::BaseModel
|
|
@@ -549,8 +546,7 @@ module Orb
|
|
|
549
546
|
)
|
|
550
547
|
.returns(T.attached_class)
|
|
551
548
|
end
|
|
552
|
-
def self.new(city:, country:, line1:, line2:, postal_code:, state:)
|
|
553
|
-
end
|
|
549
|
+
def self.new(city:, country:, line1:, line2:, postal_code:, state:); end
|
|
554
550
|
|
|
555
551
|
sig do
|
|
556
552
|
override
|
|
@@ -565,8 +561,7 @@ module Orb
|
|
|
565
561
|
}
|
|
566
562
|
)
|
|
567
563
|
end
|
|
568
|
-
def to_hash
|
|
569
|
-
end
|
|
564
|
+
def to_hash; end
|
|
570
565
|
end
|
|
571
566
|
|
|
572
567
|
class CreditNote < Orb::Internal::Type::BaseModel
|
|
@@ -590,7 +585,7 @@ module Orb
|
|
|
590
585
|
attr_accessor :type
|
|
591
586
|
|
|
592
587
|
# If the credit note has a status of `void`, this gives a timestamp when the
|
|
593
|
-
#
|
|
588
|
+
# credit note was voided.
|
|
594
589
|
sig { returns(T.nilable(Time)) }
|
|
595
590
|
attr_accessor :voided_at
|
|
596
591
|
|
|
@@ -606,8 +601,7 @@ module Orb
|
|
|
606
601
|
)
|
|
607
602
|
.returns(T.attached_class)
|
|
608
603
|
end
|
|
609
|
-
def self.new(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:)
|
|
610
|
-
end
|
|
604
|
+
def self.new(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:); end
|
|
611
605
|
|
|
612
606
|
sig do
|
|
613
607
|
override
|
|
@@ -623,8 +617,7 @@ module Orb
|
|
|
623
617
|
}
|
|
624
618
|
)
|
|
625
619
|
end
|
|
626
|
-
def to_hash
|
|
627
|
-
end
|
|
620
|
+
def to_hash; end
|
|
628
621
|
end
|
|
629
622
|
|
|
630
623
|
class Customer < Orb::Internal::Type::BaseModel
|
|
@@ -635,12 +628,10 @@ module Orb
|
|
|
635
628
|
attr_accessor :external_customer_id
|
|
636
629
|
|
|
637
630
|
sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) }
|
|
638
|
-
def self.new(id:, external_customer_id:)
|
|
639
|
-
end
|
|
631
|
+
def self.new(id:, external_customer_id:); end
|
|
640
632
|
|
|
641
633
|
sig { override.returns({id: String, external_customer_id: T.nilable(String)}) }
|
|
642
|
-
def to_hash
|
|
643
|
-
end
|
|
634
|
+
def to_hash; end
|
|
644
635
|
end
|
|
645
636
|
|
|
646
637
|
class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel
|
|
@@ -675,7 +666,7 @@ module Orb
|
|
|
675
666
|
attr_accessor :description
|
|
676
667
|
|
|
677
668
|
# The new value of the customer's balance prior to the transaction, in the
|
|
678
|
-
#
|
|
669
|
+
# customer's currency.
|
|
679
670
|
sig { returns(String) }
|
|
680
671
|
attr_accessor :ending_balance
|
|
681
672
|
|
|
@@ -691,7 +682,7 @@ module Orb
|
|
|
691
682
|
attr_writer :invoice
|
|
692
683
|
|
|
693
684
|
# The original value of the customer's balance prior to the transaction, in the
|
|
694
|
-
#
|
|
685
|
+
# customer's currency.
|
|
695
686
|
sig { returns(String) }
|
|
696
687
|
attr_accessor :starting_balance
|
|
697
688
|
|
|
@@ -724,9 +715,7 @@ module Orb
|
|
|
724
715
|
invoice:,
|
|
725
716
|
starting_balance:,
|
|
726
717
|
type:
|
|
727
|
-
)
|
|
728
|
-
end
|
|
729
|
-
|
|
718
|
+
); end
|
|
730
719
|
sig do
|
|
731
720
|
override
|
|
732
721
|
.returns(
|
|
@@ -744,8 +733,7 @@ module Orb
|
|
|
744
733
|
}
|
|
745
734
|
)
|
|
746
735
|
end
|
|
747
|
-
def to_hash
|
|
748
|
-
end
|
|
736
|
+
def to_hash; end
|
|
749
737
|
|
|
750
738
|
module Action
|
|
751
739
|
extend Orb::Internal::Type::Enum
|
|
@@ -774,8 +762,7 @@ module Orb
|
|
|
774
762
|
T.let(:external_payment, Orb::Models::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol)
|
|
775
763
|
|
|
776
764
|
sig { override.returns(T::Array[Orb::Models::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol]) }
|
|
777
|
-
def self.values
|
|
778
|
-
end
|
|
765
|
+
def self.values; end
|
|
779
766
|
end
|
|
780
767
|
|
|
781
768
|
class CreditNote < Orb::Internal::Type::BaseModel
|
|
@@ -784,12 +771,10 @@ module Orb
|
|
|
784
771
|
attr_accessor :id
|
|
785
772
|
|
|
786
773
|
sig { params(id: String).returns(T.attached_class) }
|
|
787
|
-
def self.new(id:)
|
|
788
|
-
end
|
|
774
|
+
def self.new(id:); end
|
|
789
775
|
|
|
790
776
|
sig { override.returns({id: String}) }
|
|
791
|
-
def to_hash
|
|
792
|
-
end
|
|
777
|
+
def to_hash; end
|
|
793
778
|
end
|
|
794
779
|
|
|
795
780
|
class Invoice < Orb::Internal::Type::BaseModel
|
|
@@ -798,12 +783,10 @@ module Orb
|
|
|
798
783
|
attr_accessor :id
|
|
799
784
|
|
|
800
785
|
sig { params(id: String).returns(T.attached_class) }
|
|
801
|
-
def self.new(id:)
|
|
802
|
-
end
|
|
786
|
+
def self.new(id:); end
|
|
803
787
|
|
|
804
788
|
sig { override.returns({id: String}) }
|
|
805
|
-
def to_hash
|
|
806
|
-
end
|
|
789
|
+
def to_hash; end
|
|
807
790
|
end
|
|
808
791
|
|
|
809
792
|
module Type
|
|
@@ -817,8 +800,7 @@ module Orb
|
|
|
817
800
|
DECREMENT = T.let(:decrement, Orb::Models::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol)
|
|
818
801
|
|
|
819
802
|
sig { override.returns(T::Array[Orb::Models::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol]) }
|
|
820
|
-
def self.values
|
|
821
|
-
end
|
|
803
|
+
def self.values; end
|
|
822
804
|
end
|
|
823
805
|
end
|
|
824
806
|
|
|
@@ -833,110 +815,110 @@ module Orb
|
|
|
833
815
|
attr_accessor :value
|
|
834
816
|
|
|
835
817
|
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
|
836
|
-
#
|
|
818
|
+
# added to the headers of invoices.
|
|
837
819
|
#
|
|
838
|
-
#
|
|
820
|
+
# ### Supported Tax ID Countries and Types
|
|
839
821
|
#
|
|
840
|
-
#
|
|
841
|
-
#
|
|
842
|
-
#
|
|
843
|
-
#
|
|
844
|
-
#
|
|
845
|
-
#
|
|
846
|
-
#
|
|
847
|
-
#
|
|
848
|
-
#
|
|
849
|
-
#
|
|
850
|
-
#
|
|
851
|
-
#
|
|
852
|
-
#
|
|
853
|
-
#
|
|
854
|
-
#
|
|
855
|
-
#
|
|
856
|
-
#
|
|
857
|
-
#
|
|
858
|
-
#
|
|
859
|
-
#
|
|
860
|
-
#
|
|
861
|
-
#
|
|
862
|
-
#
|
|
863
|
-
#
|
|
864
|
-
#
|
|
865
|
-
#
|
|
866
|
-
#
|
|
867
|
-
#
|
|
868
|
-
#
|
|
869
|
-
#
|
|
870
|
-
#
|
|
871
|
-
#
|
|
872
|
-
#
|
|
873
|
-
#
|
|
874
|
-
#
|
|
875
|
-
#
|
|
876
|
-
#
|
|
877
|
-
#
|
|
878
|
-
#
|
|
879
|
-
#
|
|
880
|
-
#
|
|
881
|
-
#
|
|
882
|
-
#
|
|
883
|
-
#
|
|
884
|
-
#
|
|
885
|
-
#
|
|
886
|
-
#
|
|
887
|
-
#
|
|
888
|
-
#
|
|
889
|
-
#
|
|
890
|
-
#
|
|
891
|
-
#
|
|
892
|
-
#
|
|
893
|
-
#
|
|
894
|
-
#
|
|
895
|
-
#
|
|
896
|
-
#
|
|
897
|
-
#
|
|
898
|
-
#
|
|
899
|
-
#
|
|
900
|
-
#
|
|
901
|
-
#
|
|
902
|
-
#
|
|
903
|
-
#
|
|
904
|
-
#
|
|
905
|
-
#
|
|
906
|
-
#
|
|
907
|
-
#
|
|
908
|
-
#
|
|
909
|
-
#
|
|
910
|
-
#
|
|
911
|
-
#
|
|
912
|
-
#
|
|
913
|
-
#
|
|
914
|
-
#
|
|
915
|
-
#
|
|
916
|
-
#
|
|
917
|
-
#
|
|
918
|
-
#
|
|
919
|
-
#
|
|
920
|
-
#
|
|
921
|
-
#
|
|
922
|
-
#
|
|
923
|
-
#
|
|
924
|
-
#
|
|
925
|
-
#
|
|
926
|
-
#
|
|
927
|
-
#
|
|
928
|
-
#
|
|
929
|
-
#
|
|
930
|
-
#
|
|
931
|
-
#
|
|
932
|
-
#
|
|
933
|
-
#
|
|
934
|
-
#
|
|
935
|
-
#
|
|
936
|
-
#
|
|
937
|
-
#
|
|
938
|
-
#
|
|
939
|
-
#
|
|
822
|
+
# | Country | Type | Description |
|
|
823
|
+
# | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
|
824
|
+
# | Andorra | `ad_nrt` | Andorran NRT Number |
|
|
825
|
+
# | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
|
826
|
+
# | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
|
827
|
+
# | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
|
828
|
+
# | Austria | `eu_vat` | European VAT Number |
|
|
829
|
+
# | Bahrain | `bh_vat` | Bahraini VAT Number |
|
|
830
|
+
# | Belgium | `eu_vat` | European VAT Number |
|
|
831
|
+
# | Bolivia | `bo_tin` | Bolivian Tax ID |
|
|
832
|
+
# | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
|
833
|
+
# | Brazil | `br_cpf` | Brazilian CPF Number |
|
|
834
|
+
# | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
|
835
|
+
# | Bulgaria | `eu_vat` | European VAT Number |
|
|
836
|
+
# | Canada | `ca_bn` | Canadian BN |
|
|
837
|
+
# | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
|
838
|
+
# | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
|
839
|
+
# | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
|
840
|
+
# | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
|
841
|
+
# | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
|
842
|
+
# | Chile | `cl_tin` | Chilean TIN |
|
|
843
|
+
# | China | `cn_tin` | Chinese Tax ID |
|
|
844
|
+
# | Colombia | `co_nit` | Colombian NIT Number |
|
|
845
|
+
# | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
|
846
|
+
# | Croatia | `eu_vat` | European VAT Number |
|
|
847
|
+
# | Cyprus | `eu_vat` | European VAT Number |
|
|
848
|
+
# | Czech Republic | `eu_vat` | European VAT Number |
|
|
849
|
+
# | Denmark | `eu_vat` | European VAT Number |
|
|
850
|
+
# | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
|
851
|
+
# | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
|
852
|
+
# | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
|
853
|
+
# | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
|
854
|
+
# | Estonia | `eu_vat` | European VAT Number |
|
|
855
|
+
# | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
|
856
|
+
# | Finland | `eu_vat` | European VAT Number |
|
|
857
|
+
# | France | `eu_vat` | European VAT Number |
|
|
858
|
+
# | Georgia | `ge_vat` | Georgian VAT |
|
|
859
|
+
# | Germany | `eu_vat` | European VAT Number |
|
|
860
|
+
# | Greece | `eu_vat` | European VAT Number |
|
|
861
|
+
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
|
862
|
+
# | Hungary | `eu_vat` | European VAT Number |
|
|
863
|
+
# | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
|
864
|
+
# | Iceland | `is_vat` | Icelandic VAT |
|
|
865
|
+
# | India | `in_gst` | Indian GST Number |
|
|
866
|
+
# | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
|
867
|
+
# | Ireland | `eu_vat` | European VAT Number |
|
|
868
|
+
# | Israel | `il_vat` | Israel VAT |
|
|
869
|
+
# | Italy | `eu_vat` | European VAT Number |
|
|
870
|
+
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
|
871
|
+
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
|
872
|
+
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
|
873
|
+
# | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
|
874
|
+
# | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
|
875
|
+
# | Latvia | `eu_vat` | European VAT Number |
|
|
876
|
+
# | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
|
877
|
+
# | Lithuania | `eu_vat` | European VAT Number |
|
|
878
|
+
# | Luxembourg | `eu_vat` | European VAT Number |
|
|
879
|
+
# | Malaysia | `my_frp` | Malaysian FRP Number |
|
|
880
|
+
# | Malaysia | `my_itn` | Malaysian ITN |
|
|
881
|
+
# | Malaysia | `my_sst` | Malaysian SST Number |
|
|
882
|
+
# | Malta | `eu_vat ` | European VAT Number |
|
|
883
|
+
# | Mexico | `mx_rfc` | Mexican RFC Number |
|
|
884
|
+
# | Netherlands | `eu_vat` | European VAT Number |
|
|
885
|
+
# | New Zealand | `nz_gst` | New Zealand GST Number |
|
|
886
|
+
# | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
|
887
|
+
# | Norway | `no_vat` | Norwegian VAT Number |
|
|
888
|
+
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
|
889
|
+
# | Oman | `om_vat` | Omani VAT Number |
|
|
890
|
+
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
|
891
|
+
# | Philippines | `ph_tin ` | Philippines Tax Identification Number |
|
|
892
|
+
# | Poland | `eu_vat` | European VAT Number |
|
|
893
|
+
# | Portugal | `eu_vat` | European VAT Number |
|
|
894
|
+
# | Romania | `eu_vat` | European VAT Number |
|
|
895
|
+
# | Romania | `ro_tin` | Romanian Tax ID Number |
|
|
896
|
+
# | Russia | `ru_inn` | Russian INN |
|
|
897
|
+
# | Russia | `ru_kpp` | Russian KPP |
|
|
898
|
+
# | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
|
899
|
+
# | Serbia | `rs_pib` | Serbian PIB Number |
|
|
900
|
+
# | Singapore | `sg_gst` | Singaporean GST |
|
|
901
|
+
# | Singapore | `sg_uen` | Singaporean UEN |
|
|
902
|
+
# | Slovakia | `eu_vat` | European VAT Number |
|
|
903
|
+
# | Slovenia | `eu_vat` | European VAT Number |
|
|
904
|
+
# | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
|
905
|
+
# | South Africa | `za_vat` | South African VAT Number |
|
|
906
|
+
# | South Korea | `kr_brn` | Korean BRN |
|
|
907
|
+
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
|
908
|
+
# | Spain | `eu_vat` | European VAT Number |
|
|
909
|
+
# | Sweden | `eu_vat` | European VAT Number |
|
|
910
|
+
# | Switzerland | `ch_vat` | Switzerland VAT Number |
|
|
911
|
+
# | Taiwan | `tw_vat` | Taiwanese VAT |
|
|
912
|
+
# | Thailand | `th_vat` | Thai VAT |
|
|
913
|
+
# | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
|
914
|
+
# | Ukraine | `ua_vat` | Ukrainian VAT |
|
|
915
|
+
# | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
|
916
|
+
# | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
|
|
917
|
+
# | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
|
918
|
+
# | United States | `us_ein` | United States EIN |
|
|
919
|
+
# | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
|
920
|
+
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
|
921
|
+
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
|
940
922
|
sig do
|
|
941
923
|
params(
|
|
942
924
|
country: Orb::Models::Invoice::CustomerTaxID::Country::OrSymbol,
|
|
@@ -945,8 +927,7 @@ module Orb
|
|
|
945
927
|
)
|
|
946
928
|
.returns(T.attached_class)
|
|
947
929
|
end
|
|
948
|
-
def self.new(country:, type:, value:)
|
|
949
|
-
end
|
|
930
|
+
def self.new(country:, type:, value:); end
|
|
950
931
|
|
|
951
932
|
sig do
|
|
952
933
|
override
|
|
@@ -958,8 +939,7 @@ module Orb
|
|
|
958
939
|
}
|
|
959
940
|
)
|
|
960
941
|
end
|
|
961
|
-
def to_hash
|
|
962
|
-
end
|
|
942
|
+
def to_hash; end
|
|
963
943
|
|
|
964
944
|
module Country
|
|
965
945
|
extend Orb::Internal::Type::Enum
|
|
@@ -1048,8 +1028,7 @@ module Orb
|
|
|
1048
1028
|
ZA = T.let(:ZA, Orb::Models::Invoice::CustomerTaxID::Country::TaggedSymbol)
|
|
1049
1029
|
|
|
1050
1030
|
sig { override.returns(T::Array[Orb::Models::Invoice::CustomerTaxID::Country::TaggedSymbol]) }
|
|
1051
|
-
def self.values
|
|
1052
|
-
end
|
|
1031
|
+
def self.values; end
|
|
1053
1032
|
end
|
|
1054
1033
|
|
|
1055
1034
|
module Type
|
|
@@ -1132,8 +1111,7 @@ module Orb
|
|
|
1132
1111
|
ZA_VAT = T.let(:za_vat, Orb::Models::Invoice::CustomerTaxID::Type::TaggedSymbol)
|
|
1133
1112
|
|
|
1134
1113
|
sig { override.returns(T::Array[Orb::Models::Invoice::CustomerTaxID::Type::TaggedSymbol]) }
|
|
1135
|
-
def self.values
|
|
1136
|
-
end
|
|
1114
|
+
def self.values; end
|
|
1137
1115
|
end
|
|
1138
1116
|
end
|
|
1139
1117
|
|
|
@@ -1148,8 +1126,7 @@ module Orb
|
|
|
1148
1126
|
ONE_OFF = T.let(:one_off, Orb::Models::Invoice::InvoiceSource::TaggedSymbol)
|
|
1149
1127
|
|
|
1150
1128
|
sig { override.returns(T::Array[Orb::Models::Invoice::InvoiceSource::TaggedSymbol]) }
|
|
1151
|
-
def self.values
|
|
1152
|
-
end
|
|
1129
|
+
def self.values; end
|
|
1153
1130
|
end
|
|
1154
1131
|
|
|
1155
1132
|
class LineItem < Orb::Internal::Type::BaseModel
|
|
@@ -1158,30 +1135,30 @@ module Orb
|
|
|
1158
1135
|
attr_accessor :id
|
|
1159
1136
|
|
|
1160
1137
|
# The line amount after any adjustments and before overage conversion, credits and
|
|
1161
|
-
#
|
|
1138
|
+
# partial invoicing.
|
|
1162
1139
|
sig { returns(String) }
|
|
1163
1140
|
attr_accessor :adjusted_subtotal
|
|
1164
1141
|
|
|
1165
1142
|
# All adjustments applied to the line item in the order they were applied based on
|
|
1166
|
-
#
|
|
1167
|
-
#
|
|
1143
|
+
# invoice calculations (ie. usage discounts -> amount discounts -> percentage
|
|
1144
|
+
# discounts -> minimums -> maximums).
|
|
1168
1145
|
sig do
|
|
1169
1146
|
returns(
|
|
1170
1147
|
T::Array[
|
|
1171
|
-
|
|
1172
|
-
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
|
|
1148
|
+
T.any(
|
|
1149
|
+
Orb::Models::Invoice::LineItem::Adjustment::MonetaryUsageDiscountAdjustment,
|
|
1150
|
+
Orb::Models::Invoice::LineItem::Adjustment::MonetaryAmountDiscountAdjustment,
|
|
1151
|
+
Orb::Models::Invoice::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment,
|
|
1152
|
+
Orb::Models::Invoice::LineItem::Adjustment::MonetaryMinimumAdjustment,
|
|
1153
|
+
Orb::Models::Invoice::LineItem::Adjustment::MonetaryMaximumAdjustment
|
|
1154
|
+
)
|
|
1178
1155
|
]
|
|
1179
1156
|
)
|
|
1180
1157
|
end
|
|
1181
1158
|
attr_accessor :adjustments
|
|
1182
1159
|
|
|
1183
1160
|
# The final amount for a line item after all adjustments and pre paid credits have
|
|
1184
|
-
#
|
|
1161
|
+
# been applied.
|
|
1185
1162
|
sig { returns(String) }
|
|
1186
1163
|
attr_accessor :amount
|
|
1187
1164
|
|
|
@@ -1212,8 +1189,8 @@ module Orb
|
|
|
1212
1189
|
attr_accessor :filter
|
|
1213
1190
|
|
|
1214
1191
|
# [DEPRECATED] For configured prices that are split by a grouping key, this will
|
|
1215
|
-
#
|
|
1216
|
-
#
|
|
1192
|
+
# be populated with the key and a value. The `amount` and `subtotal` will be the
|
|
1193
|
+
# values for this particular grouping.
|
|
1217
1194
|
sig { returns(T.nilable(String)) }
|
|
1218
1195
|
attr_accessor :grouping
|
|
1219
1196
|
|
|
@@ -1248,15 +1225,15 @@ module Orb
|
|
|
1248
1225
|
attr_accessor :partially_invoiced_amount
|
|
1249
1226
|
|
|
1250
1227
|
# The Price resource represents a price that can be billed on a subscription,
|
|
1251
|
-
#
|
|
1252
|
-
#
|
|
1228
|
+
# resulting in a charge on an invoice in the form of an invoice line item. Prices
|
|
1229
|
+
# take a quantity and determine an amount to bill.
|
|
1253
1230
|
#
|
|
1254
|
-
#
|
|
1255
|
-
#
|
|
1256
|
-
#
|
|
1231
|
+
# Orb supports a few different pricing models out of the box. Each of these models
|
|
1232
|
+
# is serialized differently in a given Price object. The model_type field
|
|
1233
|
+
# determines the key for the configuration object that is present.
|
|
1257
1234
|
#
|
|
1258
|
-
#
|
|
1259
|
-
#
|
|
1235
|
+
# For more on the types of prices, see
|
|
1236
|
+
# [the core concepts documentation](/core-concepts#plan-and-price)
|
|
1260
1237
|
sig do
|
|
1261
1238
|
returns(
|
|
1262
1239
|
T.nilable(
|
|
@@ -1304,15 +1281,15 @@ module Orb
|
|
|
1304
1281
|
attr_accessor :start_date
|
|
1305
1282
|
|
|
1306
1283
|
# For complex pricing structures, the line item can be broken down further in
|
|
1307
|
-
#
|
|
1284
|
+
# `sub_line_items`.
|
|
1308
1285
|
sig do
|
|
1309
1286
|
returns(
|
|
1310
1287
|
T::Array[
|
|
1311
|
-
|
|
1312
|
-
|
|
1313
|
-
|
|
1314
|
-
|
|
1315
|
-
|
|
1288
|
+
T.any(
|
|
1289
|
+
Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem,
|
|
1290
|
+
Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem,
|
|
1291
|
+
Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem
|
|
1292
|
+
)
|
|
1316
1293
|
]
|
|
1317
1294
|
)
|
|
1318
1295
|
end
|
|
@@ -1323,7 +1300,7 @@ module Orb
|
|
|
1323
1300
|
attr_accessor :subtotal
|
|
1324
1301
|
|
|
1325
1302
|
# An array of tax rates and their incurred tax amounts. Empty if no tax
|
|
1326
|
-
#
|
|
1303
|
+
# integration is configured.
|
|
1327
1304
|
sig { returns(T::Array[Orb::Models::Invoice::LineItem::TaxAmount]) }
|
|
1328
1305
|
attr_accessor :tax_amounts
|
|
1329
1306
|
|
|
@@ -1336,14 +1313,14 @@ module Orb
|
|
|
1336
1313
|
id: String,
|
|
1337
1314
|
adjusted_subtotal: String,
|
|
1338
1315
|
adjustments: T::Array[
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
|
|
1343
|
-
|
|
1344
|
-
|
|
1345
|
-
|
|
1346
|
-
|
|
1316
|
+
T.any(
|
|
1317
|
+
Orb::Models::Invoice::LineItem::Adjustment::MonetaryUsageDiscountAdjustment,
|
|
1318
|
+
Orb::Internal::AnyHash,
|
|
1319
|
+
Orb::Models::Invoice::LineItem::Adjustment::MonetaryAmountDiscountAdjustment,
|
|
1320
|
+
Orb::Models::Invoice::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment,
|
|
1321
|
+
Orb::Models::Invoice::LineItem::Adjustment::MonetaryMinimumAdjustment,
|
|
1322
|
+
Orb::Models::Invoice::LineItem::Adjustment::MonetaryMaximumAdjustment
|
|
1323
|
+
)
|
|
1347
1324
|
],
|
|
1348
1325
|
amount: String,
|
|
1349
1326
|
credits_applied: String,
|
|
@@ -1401,12 +1378,12 @@ module Orb
|
|
|
1401
1378
|
quantity: Float,
|
|
1402
1379
|
start_date: Time,
|
|
1403
1380
|
sub_line_items: T::Array[
|
|
1404
|
-
|
|
1405
|
-
|
|
1406
|
-
|
|
1407
|
-
|
|
1408
|
-
|
|
1409
|
-
|
|
1381
|
+
T.any(
|
|
1382
|
+
Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem,
|
|
1383
|
+
Orb::Internal::AnyHash,
|
|
1384
|
+
Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem,
|
|
1385
|
+
Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem
|
|
1386
|
+
)
|
|
1410
1387
|
],
|
|
1411
1388
|
subtotal: String,
|
|
1412
1389
|
tax_amounts: T::Array[T.any(Orb::Models::Invoice::LineItem::TaxAmount, Orb::Internal::AnyHash)],
|
|
@@ -1437,9 +1414,7 @@ module Orb
|
|
|
1437
1414
|
subtotal:,
|
|
1438
1415
|
tax_amounts:,
|
|
1439
1416
|
usage_customer_ids:
|
|
1440
|
-
)
|
|
1441
|
-
end
|
|
1442
|
-
|
|
1417
|
+
); end
|
|
1443
1418
|
sig do
|
|
1444
1419
|
override
|
|
1445
1420
|
.returns(
|
|
@@ -1447,13 +1422,13 @@ module Orb
|
|
|
1447
1422
|
id: String,
|
|
1448
1423
|
adjusted_subtotal: String,
|
|
1449
1424
|
adjustments: T::Array[
|
|
1450
|
-
|
|
1451
|
-
|
|
1452
|
-
|
|
1453
|
-
|
|
1454
|
-
|
|
1455
|
-
|
|
1456
|
-
|
|
1425
|
+
T.any(
|
|
1426
|
+
Orb::Models::Invoice::LineItem::Adjustment::MonetaryUsageDiscountAdjustment,
|
|
1427
|
+
Orb::Models::Invoice::LineItem::Adjustment::MonetaryAmountDiscountAdjustment,
|
|
1428
|
+
Orb::Models::Invoice::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment,
|
|
1429
|
+
Orb::Models::Invoice::LineItem::Adjustment::MonetaryMinimumAdjustment,
|
|
1430
|
+
Orb::Models::Invoice::LineItem::Adjustment::MonetaryMaximumAdjustment
|
|
1431
|
+
)
|
|
1457
1432
|
],
|
|
1458
1433
|
amount: String,
|
|
1459
1434
|
credits_applied: String,
|
|
@@ -1509,11 +1484,11 @@ module Orb
|
|
|
1509
1484
|
quantity: Float,
|
|
1510
1485
|
start_date: Time,
|
|
1511
1486
|
sub_line_items: T::Array[
|
|
1512
|
-
|
|
1513
|
-
|
|
1514
|
-
|
|
1515
|
-
|
|
1516
|
-
|
|
1487
|
+
T.any(
|
|
1488
|
+
Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem,
|
|
1489
|
+
Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem,
|
|
1490
|
+
Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem
|
|
1491
|
+
)
|
|
1517
1492
|
],
|
|
1518
1493
|
subtotal: String,
|
|
1519
1494
|
tax_amounts: T::Array[Orb::Models::Invoice::LineItem::TaxAmount],
|
|
@@ -1521,8 +1496,7 @@ module Orb
|
|
|
1521
1496
|
}
|
|
1522
1497
|
)
|
|
1523
1498
|
end
|
|
1524
|
-
def to_hash
|
|
1525
|
-
end
|
|
1499
|
+
def to_hash; end
|
|
1526
1500
|
|
|
1527
1501
|
module Adjustment
|
|
1528
1502
|
extend Orb::Internal::Type::Union
|
|
@@ -1543,7 +1517,7 @@ module Orb
|
|
|
1543
1517
|
attr_accessor :applies_to_price_ids
|
|
1544
1518
|
|
|
1545
1519
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
|
1546
|
-
#
|
|
1520
|
+
# that apply to only one price.
|
|
1547
1521
|
sig { returns(T::Boolean) }
|
|
1548
1522
|
attr_accessor :is_invoice_level
|
|
1549
1523
|
|
|
@@ -1552,7 +1526,7 @@ module Orb
|
|
|
1552
1526
|
attr_accessor :reason
|
|
1553
1527
|
|
|
1554
1528
|
# The number of usage units by which to discount the price this adjustment applies
|
|
1555
|
-
#
|
|
1529
|
+
# to in a given billing period.
|
|
1556
1530
|
sig { returns(Float) }
|
|
1557
1531
|
attr_accessor :usage_discount
|
|
1558
1532
|
|
|
@@ -1576,9 +1550,7 @@ module Orb
|
|
|
1576
1550
|
reason:,
|
|
1577
1551
|
usage_discount:,
|
|
1578
1552
|
adjustment_type: :usage_discount
|
|
1579
|
-
)
|
|
1580
|
-
end
|
|
1581
|
-
|
|
1553
|
+
); end
|
|
1582
1554
|
sig do
|
|
1583
1555
|
override
|
|
1584
1556
|
.returns(
|
|
@@ -1593,8 +1565,7 @@ module Orb
|
|
|
1593
1565
|
}
|
|
1594
1566
|
)
|
|
1595
1567
|
end
|
|
1596
|
-
def to_hash
|
|
1597
|
-
end
|
|
1568
|
+
def to_hash; end
|
|
1598
1569
|
end
|
|
1599
1570
|
|
|
1600
1571
|
class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
|
|
@@ -1609,7 +1580,7 @@ module Orb
|
|
|
1609
1580
|
attr_accessor :amount
|
|
1610
1581
|
|
|
1611
1582
|
# The amount by which to discount the prices this adjustment applies to in a given
|
|
1612
|
-
#
|
|
1583
|
+
# billing period.
|
|
1613
1584
|
sig { returns(String) }
|
|
1614
1585
|
attr_accessor :amount_discount
|
|
1615
1586
|
|
|
@@ -1618,7 +1589,7 @@ module Orb
|
|
|
1618
1589
|
attr_accessor :applies_to_price_ids
|
|
1619
1590
|
|
|
1620
1591
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
|
1621
|
-
#
|
|
1592
|
+
# that apply to only one price.
|
|
1622
1593
|
sig { returns(T::Boolean) }
|
|
1623
1594
|
attr_accessor :is_invoice_level
|
|
1624
1595
|
|
|
@@ -1646,9 +1617,7 @@ module Orb
|
|
|
1646
1617
|
is_invoice_level:,
|
|
1647
1618
|
reason:,
|
|
1648
1619
|
adjustment_type: :amount_discount
|
|
1649
|
-
)
|
|
1650
|
-
end
|
|
1651
|
-
|
|
1620
|
+
); end
|
|
1652
1621
|
sig do
|
|
1653
1622
|
override
|
|
1654
1623
|
.returns(
|
|
@@ -1663,8 +1632,7 @@ module Orb
|
|
|
1663
1632
|
}
|
|
1664
1633
|
)
|
|
1665
1634
|
end
|
|
1666
|
-
def to_hash
|
|
1667
|
-
end
|
|
1635
|
+
def to_hash; end
|
|
1668
1636
|
end
|
|
1669
1637
|
|
|
1670
1638
|
class MonetaryPercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
|
|
@@ -1683,12 +1651,12 @@ module Orb
|
|
|
1683
1651
|
attr_accessor :applies_to_price_ids
|
|
1684
1652
|
|
|
1685
1653
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
|
1686
|
-
#
|
|
1654
|
+
# that apply to only one price.
|
|
1687
1655
|
sig { returns(T::Boolean) }
|
|
1688
1656
|
attr_accessor :is_invoice_level
|
|
1689
1657
|
|
|
1690
1658
|
# The percentage (as a value between 0 and 1) by which to discount the price
|
|
1691
|
-
#
|
|
1659
|
+
# intervals this adjustment applies to in a given billing period.
|
|
1692
1660
|
sig { returns(Float) }
|
|
1693
1661
|
attr_accessor :percentage_discount
|
|
1694
1662
|
|
|
@@ -1716,9 +1684,7 @@ module Orb
|
|
|
1716
1684
|
percentage_discount:,
|
|
1717
1685
|
reason:,
|
|
1718
1686
|
adjustment_type: :percentage_discount
|
|
1719
|
-
)
|
|
1720
|
-
end
|
|
1721
|
-
|
|
1687
|
+
); end
|
|
1722
1688
|
sig do
|
|
1723
1689
|
override
|
|
1724
1690
|
.returns(
|
|
@@ -1733,8 +1699,7 @@ module Orb
|
|
|
1733
1699
|
}
|
|
1734
1700
|
)
|
|
1735
1701
|
end
|
|
1736
|
-
def to_hash
|
|
1737
|
-
end
|
|
1702
|
+
def to_hash; end
|
|
1738
1703
|
end
|
|
1739
1704
|
|
|
1740
1705
|
class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel
|
|
@@ -1753,7 +1718,7 @@ module Orb
|
|
|
1753
1718
|
attr_accessor :applies_to_price_ids
|
|
1754
1719
|
|
|
1755
1720
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
|
1756
|
-
#
|
|
1721
|
+
# that apply to only one price.
|
|
1757
1722
|
sig { returns(T::Boolean) }
|
|
1758
1723
|
attr_accessor :is_invoice_level
|
|
1759
1724
|
|
|
@@ -1762,7 +1727,7 @@ module Orb
|
|
|
1762
1727
|
attr_accessor :item_id
|
|
1763
1728
|
|
|
1764
1729
|
# The minimum amount to charge in a given billing period for the prices this
|
|
1765
|
-
#
|
|
1730
|
+
# adjustment applies to.
|
|
1766
1731
|
sig { returns(String) }
|
|
1767
1732
|
attr_accessor :minimum_amount
|
|
1768
1733
|
|
|
@@ -1792,9 +1757,7 @@ module Orb
|
|
|
1792
1757
|
minimum_amount:,
|
|
1793
1758
|
reason:,
|
|
1794
1759
|
adjustment_type: :minimum
|
|
1795
|
-
)
|
|
1796
|
-
end
|
|
1797
|
-
|
|
1760
|
+
); end
|
|
1798
1761
|
sig do
|
|
1799
1762
|
override
|
|
1800
1763
|
.returns(
|
|
@@ -1810,8 +1773,7 @@ module Orb
|
|
|
1810
1773
|
}
|
|
1811
1774
|
)
|
|
1812
1775
|
end
|
|
1813
|
-
def to_hash
|
|
1814
|
-
end
|
|
1776
|
+
def to_hash; end
|
|
1815
1777
|
end
|
|
1816
1778
|
|
|
1817
1779
|
class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel
|
|
@@ -1830,12 +1792,12 @@ module Orb
|
|
|
1830
1792
|
attr_accessor :applies_to_price_ids
|
|
1831
1793
|
|
|
1832
1794
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
|
1833
|
-
#
|
|
1795
|
+
# that apply to only one price.
|
|
1834
1796
|
sig { returns(T::Boolean) }
|
|
1835
1797
|
attr_accessor :is_invoice_level
|
|
1836
1798
|
|
|
1837
1799
|
# The maximum amount to charge in a given billing period for the prices this
|
|
1838
|
-
#
|
|
1800
|
+
# adjustment applies to.
|
|
1839
1801
|
sig { returns(String) }
|
|
1840
1802
|
attr_accessor :maximum_amount
|
|
1841
1803
|
|
|
@@ -1863,9 +1825,7 @@ module Orb
|
|
|
1863
1825
|
maximum_amount:,
|
|
1864
1826
|
reason:,
|
|
1865
1827
|
adjustment_type: :maximum
|
|
1866
|
-
)
|
|
1867
|
-
end
|
|
1868
|
-
|
|
1828
|
+
); end
|
|
1869
1829
|
sig do
|
|
1870
1830
|
override
|
|
1871
1831
|
.returns(
|
|
@@ -1880,8 +1840,7 @@ module Orb
|
|
|
1880
1840
|
}
|
|
1881
1841
|
)
|
|
1882
1842
|
end
|
|
1883
|
-
def to_hash
|
|
1884
|
-
end
|
|
1843
|
+
def to_hash; end
|
|
1885
1844
|
end
|
|
1886
1845
|
|
|
1887
1846
|
sig do
|
|
@@ -1890,13 +1849,12 @@ module Orb
|
|
|
1890
1849
|
[Orb::Models::Invoice::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryMinimumAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryMaximumAdjustment]
|
|
1891
1850
|
)
|
|
1892
1851
|
end
|
|
1893
|
-
def self.variants
|
|
1894
|
-
end
|
|
1852
|
+
def self.variants; end
|
|
1895
1853
|
end
|
|
1896
1854
|
|
|
1897
1855
|
class Maximum < Orb::Internal::Type::BaseModel
|
|
1898
1856
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
|
1899
|
-
#
|
|
1857
|
+
# maximums, this can be a subset of prices.
|
|
1900
1858
|
sig { returns(T::Array[String]) }
|
|
1901
1859
|
attr_accessor :applies_to_price_ids
|
|
1902
1860
|
|
|
@@ -1908,17 +1866,15 @@ module Orb
|
|
|
1908
1866
|
sig do
|
|
1909
1867
|
params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class)
|
|
1910
1868
|
end
|
|
1911
|
-
def self.new(applies_to_price_ids:, maximum_amount:)
|
|
1912
|
-
end
|
|
1869
|
+
def self.new(applies_to_price_ids:, maximum_amount:); end
|
|
1913
1870
|
|
|
1914
1871
|
sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) }
|
|
1915
|
-
def to_hash
|
|
1916
|
-
end
|
|
1872
|
+
def to_hash; end
|
|
1917
1873
|
end
|
|
1918
1874
|
|
|
1919
1875
|
class Minimum < Orb::Internal::Type::BaseModel
|
|
1920
1876
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
|
1921
|
-
#
|
|
1877
|
+
# minimums, this can be a subset of prices.
|
|
1922
1878
|
sig { returns(T::Array[String]) }
|
|
1923
1879
|
attr_accessor :applies_to_price_ids
|
|
1924
1880
|
|
|
@@ -1930,12 +1886,10 @@ module Orb
|
|
|
1930
1886
|
sig do
|
|
1931
1887
|
params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class)
|
|
1932
1888
|
end
|
|
1933
|
-
def self.new(applies_to_price_ids:, minimum_amount:)
|
|
1934
|
-
end
|
|
1889
|
+
def self.new(applies_to_price_ids:, minimum_amount:); end
|
|
1935
1890
|
|
|
1936
1891
|
sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) }
|
|
1937
|
-
def to_hash
|
|
1938
|
-
end
|
|
1892
|
+
def to_hash; end
|
|
1939
1893
|
end
|
|
1940
1894
|
|
|
1941
1895
|
module SubLineItem
|
|
@@ -1998,8 +1952,7 @@ module Orb
|
|
|
1998
1952
|
)
|
|
1999
1953
|
.returns(T.attached_class)
|
|
2000
1954
|
end
|
|
2001
|
-
def self.new(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix)
|
|
2002
|
-
end
|
|
1955
|
+
def self.new(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix); end
|
|
2003
1956
|
|
|
2004
1957
|
sig do
|
|
2005
1958
|
override
|
|
@@ -2014,8 +1967,7 @@ module Orb
|
|
|
2014
1967
|
}
|
|
2015
1968
|
)
|
|
2016
1969
|
end
|
|
2017
|
-
def to_hash
|
|
2018
|
-
end
|
|
1970
|
+
def to_hash; end
|
|
2019
1971
|
|
|
2020
1972
|
class Grouping < Orb::Internal::Type::BaseModel
|
|
2021
1973
|
sig { returns(String) }
|
|
@@ -2026,12 +1978,10 @@ module Orb
|
|
|
2026
1978
|
attr_accessor :value
|
|
2027
1979
|
|
|
2028
1980
|
sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) }
|
|
2029
|
-
def self.new(key:, value:)
|
|
2030
|
-
end
|
|
1981
|
+
def self.new(key:, value:); end
|
|
2031
1982
|
|
|
2032
1983
|
sig { override.returns({key: String, value: T.nilable(String)}) }
|
|
2033
|
-
def to_hash
|
|
2034
|
-
end
|
|
1984
|
+
def to_hash; end
|
|
2035
1985
|
end
|
|
2036
1986
|
|
|
2037
1987
|
class MatrixConfig < Orb::Internal::Type::BaseModel
|
|
@@ -2040,12 +1990,10 @@ module Orb
|
|
|
2040
1990
|
attr_accessor :dimension_values
|
|
2041
1991
|
|
|
2042
1992
|
sig { params(dimension_values: T::Array[T.nilable(String)]).returns(T.attached_class) }
|
|
2043
|
-
def self.new(dimension_values:)
|
|
2044
|
-
end
|
|
1993
|
+
def self.new(dimension_values:); end
|
|
2045
1994
|
|
|
2046
1995
|
sig { override.returns({dimension_values: T::Array[T.nilable(String)]}) }
|
|
2047
|
-
def to_hash
|
|
2048
|
-
end
|
|
1996
|
+
def to_hash; end
|
|
2049
1997
|
end
|
|
2050
1998
|
end
|
|
2051
1999
|
|
|
@@ -2100,8 +2048,7 @@ module Orb
|
|
|
2100
2048
|
)
|
|
2101
2049
|
.returns(T.attached_class)
|
|
2102
2050
|
end
|
|
2103
|
-
def self.new(amount:, grouping:, name:, quantity:, tier_config:, type: :tier)
|
|
2104
|
-
end
|
|
2051
|
+
def self.new(amount:, grouping:, name:, quantity:, tier_config:, type: :tier); end
|
|
2105
2052
|
|
|
2106
2053
|
sig do
|
|
2107
2054
|
override
|
|
@@ -2116,8 +2063,7 @@ module Orb
|
|
|
2116
2063
|
}
|
|
2117
2064
|
)
|
|
2118
2065
|
end
|
|
2119
|
-
def to_hash
|
|
2120
|
-
end
|
|
2066
|
+
def to_hash; end
|
|
2121
2067
|
|
|
2122
2068
|
class Grouping < Orb::Internal::Type::BaseModel
|
|
2123
2069
|
sig { returns(String) }
|
|
@@ -2128,12 +2074,10 @@ module Orb
|
|
|
2128
2074
|
attr_accessor :value
|
|
2129
2075
|
|
|
2130
2076
|
sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) }
|
|
2131
|
-
def self.new(key:, value:)
|
|
2132
|
-
end
|
|
2077
|
+
def self.new(key:, value:); end
|
|
2133
2078
|
|
|
2134
2079
|
sig { override.returns({key: String, value: T.nilable(String)}) }
|
|
2135
|
-
def to_hash
|
|
2136
|
-
end
|
|
2080
|
+
def to_hash; end
|
|
2137
2081
|
end
|
|
2138
2082
|
|
|
2139
2083
|
class TierConfig < Orb::Internal::Type::BaseModel
|
|
@@ -2153,12 +2097,10 @@ module Orb
|
|
|
2153
2097
|
unit_amount: String
|
|
2154
2098
|
).returns(T.attached_class)
|
|
2155
2099
|
end
|
|
2156
|
-
def self.new(first_unit:, last_unit:, unit_amount:)
|
|
2157
|
-
end
|
|
2100
|
+
def self.new(first_unit:, last_unit:, unit_amount:); end
|
|
2158
2101
|
|
|
2159
2102
|
sig { override.returns({first_unit: Float, last_unit: T.nilable(Float), unit_amount: String}) }
|
|
2160
|
-
def to_hash
|
|
2161
|
-
end
|
|
2103
|
+
def to_hash; end
|
|
2162
2104
|
end
|
|
2163
2105
|
end
|
|
2164
2106
|
|
|
@@ -2201,8 +2143,7 @@ module Orb
|
|
|
2201
2143
|
)
|
|
2202
2144
|
.returns(T.attached_class)
|
|
2203
2145
|
end
|
|
2204
|
-
def self.new(amount:, grouping:, name:, quantity:, type: :"'null'")
|
|
2205
|
-
end
|
|
2146
|
+
def self.new(amount:, grouping:, name:, quantity:, type: :"'null'"); end
|
|
2206
2147
|
|
|
2207
2148
|
sig do
|
|
2208
2149
|
override
|
|
@@ -2216,8 +2157,7 @@ module Orb
|
|
|
2216
2157
|
}
|
|
2217
2158
|
)
|
|
2218
2159
|
end
|
|
2219
|
-
def to_hash
|
|
2220
|
-
end
|
|
2160
|
+
def to_hash; end
|
|
2221
2161
|
|
|
2222
2162
|
class Grouping < Orb::Internal::Type::BaseModel
|
|
2223
2163
|
sig { returns(String) }
|
|
@@ -2228,12 +2168,10 @@ module Orb
|
|
|
2228
2168
|
attr_accessor :value
|
|
2229
2169
|
|
|
2230
2170
|
sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) }
|
|
2231
|
-
def self.new(key:, value:)
|
|
2232
|
-
end
|
|
2171
|
+
def self.new(key:, value:); end
|
|
2233
2172
|
|
|
2234
2173
|
sig { override.returns({key: String, value: T.nilable(String)}) }
|
|
2235
|
-
def to_hash
|
|
2236
|
-
end
|
|
2174
|
+
def to_hash; end
|
|
2237
2175
|
end
|
|
2238
2176
|
end
|
|
2239
2177
|
|
|
@@ -2243,8 +2181,7 @@ module Orb
|
|
|
2243
2181
|
[Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem, Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem, Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem]
|
|
2244
2182
|
)
|
|
2245
2183
|
end
|
|
2246
|
-
def self.variants
|
|
2247
|
-
end
|
|
2184
|
+
def self.variants; end
|
|
2248
2185
|
end
|
|
2249
2186
|
|
|
2250
2187
|
class TaxAmount < Orb::Internal::Type::BaseModel
|
|
@@ -2264,8 +2201,7 @@ module Orb
|
|
|
2264
2201
|
params(amount: String, tax_rate_description: String, tax_rate_percentage: T.nilable(String))
|
|
2265
2202
|
.returns(T.attached_class)
|
|
2266
2203
|
end
|
|
2267
|
-
def self.new(amount:, tax_rate_description:, tax_rate_percentage:)
|
|
2268
|
-
end
|
|
2204
|
+
def self.new(amount:, tax_rate_description:, tax_rate_percentage:); end
|
|
2269
2205
|
|
|
2270
2206
|
sig do
|
|
2271
2207
|
override.returns(
|
|
@@ -2276,14 +2212,13 @@ module Orb
|
|
|
2276
2212
|
}
|
|
2277
2213
|
)
|
|
2278
2214
|
end
|
|
2279
|
-
def to_hash
|
|
2280
|
-
end
|
|
2215
|
+
def to_hash; end
|
|
2281
2216
|
end
|
|
2282
2217
|
end
|
|
2283
2218
|
|
|
2284
2219
|
class Maximum < Orb::Internal::Type::BaseModel
|
|
2285
2220
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
|
2286
|
-
#
|
|
2221
|
+
# maximums, this can be a subset of prices.
|
|
2287
2222
|
sig { returns(T::Array[String]) }
|
|
2288
2223
|
attr_accessor :applies_to_price_ids
|
|
2289
2224
|
|
|
@@ -2294,17 +2229,15 @@ module Orb
|
|
|
2294
2229
|
sig do
|
|
2295
2230
|
params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class)
|
|
2296
2231
|
end
|
|
2297
|
-
def self.new(applies_to_price_ids:, maximum_amount:)
|
|
2298
|
-
end
|
|
2232
|
+
def self.new(applies_to_price_ids:, maximum_amount:); end
|
|
2299
2233
|
|
|
2300
2234
|
sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) }
|
|
2301
|
-
def to_hash
|
|
2302
|
-
end
|
|
2235
|
+
def to_hash; end
|
|
2303
2236
|
end
|
|
2304
2237
|
|
|
2305
2238
|
class Minimum < Orb::Internal::Type::BaseModel
|
|
2306
2239
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
|
2307
|
-
#
|
|
2240
|
+
# minimums, this can be a subset of prices.
|
|
2308
2241
|
sig { returns(T::Array[String]) }
|
|
2309
2242
|
attr_accessor :applies_to_price_ids
|
|
2310
2243
|
|
|
@@ -2315,12 +2248,10 @@ module Orb
|
|
|
2315
2248
|
sig do
|
|
2316
2249
|
params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class)
|
|
2317
2250
|
end
|
|
2318
|
-
def self.new(applies_to_price_ids:, minimum_amount:)
|
|
2319
|
-
end
|
|
2251
|
+
def self.new(applies_to_price_ids:, minimum_amount:); end
|
|
2320
2252
|
|
|
2321
2253
|
sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) }
|
|
2322
|
-
def to_hash
|
|
2323
|
-
end
|
|
2254
|
+
def to_hash; end
|
|
2324
2255
|
end
|
|
2325
2256
|
|
|
2326
2257
|
class PaymentAttempt < Orb::Internal::Type::BaseModel
|
|
@@ -2359,8 +2290,7 @@ module Orb
|
|
|
2359
2290
|
)
|
|
2360
2291
|
.returns(T.attached_class)
|
|
2361
2292
|
end
|
|
2362
|
-
def self.new(id:, amount:, created_at:, payment_provider:, payment_provider_id:, succeeded:)
|
|
2363
|
-
end
|
|
2293
|
+
def self.new(id:, amount:, created_at:, payment_provider:, payment_provider_id:, succeeded:); end
|
|
2364
2294
|
|
|
2365
2295
|
sig do
|
|
2366
2296
|
override
|
|
@@ -2375,8 +2305,7 @@ module Orb
|
|
|
2375
2305
|
}
|
|
2376
2306
|
)
|
|
2377
2307
|
end
|
|
2378
|
-
def to_hash
|
|
2379
|
-
end
|
|
2308
|
+
def to_hash; end
|
|
2380
2309
|
|
|
2381
2310
|
# The payment provider that attempted to collect the payment.
|
|
2382
2311
|
module PaymentProvider
|
|
@@ -2389,8 +2318,7 @@ module Orb
|
|
|
2389
2318
|
STRIPE = T.let(:stripe, Orb::Models::Invoice::PaymentAttempt::PaymentProvider::TaggedSymbol)
|
|
2390
2319
|
|
|
2391
2320
|
sig { override.returns(T::Array[Orb::Models::Invoice::PaymentAttempt::PaymentProvider::TaggedSymbol]) }
|
|
2392
|
-
def self.values
|
|
2393
|
-
end
|
|
2321
|
+
def self.values; end
|
|
2394
2322
|
end
|
|
2395
2323
|
end
|
|
2396
2324
|
|
|
@@ -2424,8 +2352,7 @@ module Orb
|
|
|
2424
2352
|
)
|
|
2425
2353
|
.returns(T.attached_class)
|
|
2426
2354
|
end
|
|
2427
|
-
def self.new(city:, country:, line1:, line2:, postal_code:, state:)
|
|
2428
|
-
end
|
|
2355
|
+
def self.new(city:, country:, line1:, line2:, postal_code:, state:); end
|
|
2429
2356
|
|
|
2430
2357
|
sig do
|
|
2431
2358
|
override
|
|
@@ -2440,8 +2367,7 @@ module Orb
|
|
|
2440
2367
|
}
|
|
2441
2368
|
)
|
|
2442
2369
|
end
|
|
2443
|
-
def to_hash
|
|
2444
|
-
end
|
|
2370
|
+
def to_hash; end
|
|
2445
2371
|
end
|
|
2446
2372
|
|
|
2447
2373
|
module Status
|
|
@@ -2457,8 +2383,7 @@ module Orb
|
|
|
2457
2383
|
DRAFT = T.let(:draft, Orb::Models::Invoice::Status::TaggedSymbol)
|
|
2458
2384
|
|
|
2459
2385
|
sig { override.returns(T::Array[Orb::Models::Invoice::Status::TaggedSymbol]) }
|
|
2460
|
-
def self.values
|
|
2461
|
-
end
|
|
2386
|
+
def self.values; end
|
|
2462
2387
|
end
|
|
2463
2388
|
|
|
2464
2389
|
class Subscription < Orb::Internal::Type::BaseModel
|
|
@@ -2466,12 +2391,10 @@ module Orb
|
|
|
2466
2391
|
attr_accessor :id
|
|
2467
2392
|
|
|
2468
2393
|
sig { params(id: String).returns(T.attached_class) }
|
|
2469
|
-
def self.new(id:)
|
|
2470
|
-
end
|
|
2394
|
+
def self.new(id:); end
|
|
2471
2395
|
|
|
2472
2396
|
sig { override.returns({id: String}) }
|
|
2473
|
-
def to_hash
|
|
2474
|
-
end
|
|
2397
|
+
def to_hash; end
|
|
2475
2398
|
end
|
|
2476
2399
|
end
|
|
2477
2400
|
end
|