orb-billing 0.9.1 → 0.11.0

data/rbi/orb/models.rbi

@@ -214,6 +214,8 @@ module Orb
   SubscriptionPriceIntervalsParams =
     Orb::Models::SubscriptionPriceIntervalsParams
 
+  SubscriptionRedeemCouponParams = Orb::Models::SubscriptionRedeemCouponParams
+
   SubscriptionsAPI = Orb::Models::SubscriptionsAPI
 
   SubscriptionSchedulePlanChangeParams =

data/rbi/orb/resources/subscriptions.rbi

@@ -1007,6 +1007,34 @@ module Orb
       )
       end
 
+      # Redeem a coupon effective at a given time.
+      sig do
+        params(
+          subscription_id: String,
+          change_option:
+            Orb::SubscriptionRedeemCouponParams::ChangeOption::OrSymbol,
+          coupon_id: String,
+          allow_invoice_credit_or_void: T.nilable(T::Boolean),
+          change_date: T.nilable(Time),
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Models::SubscriptionRedeemCouponResponse)
+      end
+      def redeem_coupon(
+        subscription_id,
+        change_option:,
+        # Coupon ID to be redeemed for this subscription.
+        coupon_id:,
+        # If false, this request will fail if it would void an issued invoice or create a
+        # credit note. Consider using this as a safety mechanism if you do not expect
+        # existing invoices to be changed.
+        allow_invoice_credit_or_void: nil,
+        # The date that the coupon discount should take effect. This parameter can only be
+        # passed if the `change_option` is `requested_date`.
+        change_date: nil,
+        request_options: {}
+      )
+      end
+
       # This endpoint can be used to change an existing subscription's plan. It returns
       # the serialized updated subscription object.
       #
@@ -1408,7 +1436,7 @@ module Orb
       end
 
       # This endpoint can be used to unschedule any pending plan changes on an existing
-      # subscription.
+      # subscription. When called, all upcoming plan changes will be unscheduled.
       sig do
         params(
           subscription_id: String,

data/sig/orb/models/invoice.rbs

@@ -841,7 +841,7 @@ module Orb
           minimum_amount: String?,
           name: String,
           partially_invoiced_amount: String,
-          price: Orb::Models::price?,
+          price: Orb::Models::price,
           quantity: Float,
           start_date: Time,
           sub_line_items: ::Array[Orb::Models::Invoice::LineItem::sub_line_item],
@@ -881,7 +881,7 @@ module Orb
 
         attr_accessor partially_invoiced_amount: String
 
-        attr_accessor price: Orb::Models::price?
+        attr_accessor price: Orb::Models::price
 
         attr_accessor quantity: Float
 
@@ -911,7 +911,7 @@ module Orb
           minimum_amount: String?,
           name: String,
           partially_invoiced_amount: String,
-          price: Orb::Models::price?,
+          price: Orb::Models::price,
           quantity: Float,
           start_date: Time,
           sub_line_items: ::Array[Orb::Models::Invoice::LineItem::sub_line_item],
@@ -936,7 +936,7 @@ module Orb
           minimum_amount: String?,
           name: String,
           partially_invoiced_amount: String,
-          price: Orb::Models::price?,
+          price: Orb::Models::price,
           quantity: Float,
           start_date: Time,
           sub_line_items: ::Array[Orb::Models::Invoice::LineItem::sub_line_item],

data/sig/orb/models/invoice_fetch_upcoming_response.rbs

@@ -841,7 +841,7 @@ module Orb
           minimum_amount: String?,
           name: String,
           partially_invoiced_amount: String,
-          price: Orb::Models::price?,
+          price: Orb::Models::price,
           quantity: Float,
           start_date: Time,
           sub_line_items: ::Array[Orb::Models::InvoiceFetchUpcomingResponse::LineItem::sub_line_item],
@@ -881,7 +881,7 @@ module Orb
 
         attr_accessor partially_invoiced_amount: String
 
-        attr_accessor price: Orb::Models::price?
+        attr_accessor price: Orb::Models::price
 
         attr_accessor quantity: Float
 
@@ -911,7 +911,7 @@ module Orb
           minimum_amount: String?,
           name: String,
           partially_invoiced_amount: String,
-          price: Orb::Models::price?,
+          price: Orb::Models::price,
           quantity: Float,
           start_date: Time,
           sub_line_items: ::Array[Orb::Models::InvoiceFetchUpcomingResponse::LineItem::sub_line_item],
@@ -936,7 +936,7 @@ module Orb
           minimum_amount: String?,
           name: String,
           partially_invoiced_amount: String,
-          price: Orb::Models::price?,
+          price: Orb::Models::price,
           quantity: Float,
           start_date: Time,
           sub_line_items: ::Array[Orb::Models::InvoiceFetchUpcomingResponse::LineItem::sub_line_item],

data/sig/orb/models/invoice_line_item_create_response.rbs

@@ -17,7 +17,7 @@ module Orb
         minimum_amount: String?,
         name: String,
         partially_invoiced_amount: String,
-        price: Orb::Models::price?,
+        price: Orb::Models::price,
         quantity: Float,
         start_date: Time,
         sub_line_items: ::Array[Orb::Models::InvoiceLineItemCreateResponse::sub_line_item],
@@ -57,7 +57,7 @@ module Orb
 
       attr_accessor partially_invoiced_amount: String
 
-      attr_accessor price: Orb::Models::price?
+      attr_accessor price: Orb::Models::price
 
       attr_accessor quantity: Float
 
@@ -87,7 +87,7 @@ module Orb
         minimum_amount: String?,
         name: String,
         partially_invoiced_amount: String,
-        price: Orb::Models::price?,
+        price: Orb::Models::price,
         quantity: Float,
         start_date: Time,
         sub_line_items: ::Array[Orb::Models::InvoiceLineItemCreateResponse::sub_line_item],
@@ -112,7 +112,7 @@ module Orb
         minimum_amount: String?,
         name: String,
         partially_invoiced_amount: String,
-        price: Orb::Models::price?,
+        price: Orb::Models::price,
         quantity: Float,
         start_date: Time,
         sub_line_items: ::Array[Orb::Models::InvoiceLineItemCreateResponse::sub_line_item],

data/sig/orb/models/subscription_redeem_coupon_params.rbs

@@ -0,0 +1,54 @@
+module Orb
+  module Models
+    type subscription_redeem_coupon_params =
+      {
+        change_option: Orb::Models::SubscriptionRedeemCouponParams::change_option,
+        coupon_id: String,
+        allow_invoice_credit_or_void: bool?,
+        change_date: Time?
+      }
+      & Orb::Internal::Type::request_parameters
+
+    class SubscriptionRedeemCouponParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      attr_accessor change_option: Orb::Models::SubscriptionRedeemCouponParams::change_option
+
+      attr_accessor coupon_id: String
+
+      attr_accessor allow_invoice_credit_or_void: bool?
+
+      attr_accessor change_date: Time?
+
+      def initialize: (
+        change_option: Orb::Models::SubscriptionRedeemCouponParams::change_option,
+        coupon_id: String,
+        ?allow_invoice_credit_or_void: bool?,
+        ?change_date: Time?,
+        ?request_options: Orb::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        change_option: Orb::Models::SubscriptionRedeemCouponParams::change_option,
+        coupon_id: String,
+        allow_invoice_credit_or_void: bool?,
+        change_date: Time?,
+        request_options: Orb::RequestOptions
+      }
+
+      type change_option =
+        :requested_date | :end_of_subscription_term | :immediate
+
+      module ChangeOption
+        extend Orb::Internal::Type::Enum
+
+        REQUESTED_DATE: :requested_date
+        END_OF_SUBSCRIPTION_TERM: :end_of_subscription_term
+        IMMEDIATE: :immediate
+
+        def self?.values: -> ::Array[Orb::Models::SubscriptionRedeemCouponParams::change_option]
+      end
+    end
+  end
+end