You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: stripe/_quote.py
+8-100Lines changed: 8 additions & 100 deletions
Original file line number
Diff line number
Diff line change
@@ -629,32 +629,12 @@ class AppliesTo(StripeObject):
629
629
"""
630
630
631
631
classBillFrom(StripeObject):
632
-
classAmendmentStart(StripeObject):
633
-
index: int
634
-
"""
635
-
Use an index to specify the position of an amendment to start prebilling with.
636
-
"""
637
-
638
632
classLineStartsAt(StripeObject):
639
633
id: str
640
634
"""
641
635
Unique identifier for the object.
642
636
"""
643
637
644
-
classRelative(StripeObject):
645
-
interval: Literal["day", "month", "week", "year"]
646
-
"""
647
-
Specifies billing duration. Possible values are `day`, `week`, `month`, or `year`.
648
-
"""
649
-
interval_count: Optional[int]
650
-
"""
651
-
The multiplier applied to the interval.
652
-
"""
653
-
654
-
amendment_start: Optional[AmendmentStart]
655
-
"""
656
-
Use an index to specify the position of an amendment to start prebilling with.
657
-
"""
658
638
computed_timestamp: Optional[int]
659
639
"""
660
640
The time the billing schedule applies from.
@@ -663,39 +643,22 @@ class Relative(StripeObject):
663
643
"""
664
644
Lets you bill the period starting from a particular Quote line.
665
645
"""
666
-
relative: Optional[Relative]
667
-
"""
668
-
Timestamp is calculated from the request time.
669
-
"""
670
646
timestamp: Optional[int]
671
647
"""
672
648
Use a precise Unix timestamp for prebilling to start. Must be earlier than `bill_until`.
673
649
"""
674
650
type: Literal[
675
-
"amendment_start",
676
651
"line_starts_at",
677
-
"now",
678
652
"pause_collection_start",
679
653
"quote_acceptance_date",
680
-
"relative",
681
654
"timestamp",
682
655
]
683
656
"""
684
657
Describes how the billing schedule determines the start date. Possible values are `timestamp`, `relative`, `amendment_start`, `now`, `quote_acceptance_date`, `line_starts_at`, or `pause_collection_start`.
Use an index to specify the position of an amendment to end prebilling with.
697
-
"""
698
-
699
662
classDuration(StripeObject):
700
663
interval: Literal["day", "month", "week", "year"]
701
664
"""
@@ -712,11 +675,7 @@ class LineEndsAt(StripeObject):
712
675
Unique identifier for the object.
713
676
"""
714
677
715
-
amendment_end: Optional[AmendmentEnd]
716
-
"""
717
-
Use an index to specify the position of an amendment to end prebilling with.
718
-
"""
719
-
computed_timestamp: int
678
+
computed_timestamp: Optional[int]
720
679
"""
721
680
The timestamp the billing schedule will apply until.
722
681
"""
@@ -733,7 +692,6 @@ class LineEndsAt(StripeObject):
733
692
If specified, the billing schedule will apply until the specified timestamp.
734
693
"""
735
694
type: Literal[
736
-
"amendment_end",
737
695
"duration",
738
696
"line_ends_at",
739
697
"schedule_end",
@@ -744,7 +702,6 @@ class LineEndsAt(StripeObject):
744
702
Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
745
703
"""
746
704
_inner_class_types= {
747
-
"amendment_end": AmendmentEnd,
748
705
"duration": Duration,
749
706
"line_ends_at": LineEndsAt,
750
707
}
@@ -758,9 +715,6 @@ class LineEndsAt(StripeObject):
758
715
Specifies the start of the billing period.
759
716
"""
760
717
bill_until: BillUntil
761
-
"""
762
-
Specifies the end of billing period.
763
-
"""
764
718
key: str
765
719
"""
766
720
Unique identifier for the billing schedule.
@@ -817,10 +771,10 @@ class Prebilling(StripeObject):
817
771
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
818
772
"""
819
773
phase_effective_at: Optional[
820
-
Literal["billing_period_start", "phase_start"]
774
+
Literal["billing_period_start", "line_start"]
821
775
]
822
776
"""
823
-
Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
777
+
Configures how the quote handles billing for line transitions. Possible values are `line_start` (default) or `billing_period_start`. `line_start` bills based on the current state of the line, ignoring changes scheduled for future lines. `billing_period_start` bills predictively for upcoming line transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
824
778
"""
825
779
prebilling: Optional[Prebilling]
826
780
"""
@@ -963,32 +917,12 @@ class AppliesTo(StripeObject):
963
917
"""
964
918
965
919
classBillFrom(StripeObject):
966
-
classAmendmentStart(StripeObject):
967
-
index: int
968
-
"""
969
-
Use an index to specify the position of an amendment to start prebilling with.
970
-
"""
971
-
972
920
classLineStartsAt(StripeObject):
973
921
id: str
974
922
"""
975
923
Unique identifier for the object.
976
924
"""
977
925
978
-
classRelative(StripeObject):
979
-
interval: Literal["day", "month", "week", "year"]
980
-
"""
981
-
Specifies billing duration. Possible values are `day`, `week`, `month`, or `year`.
982
-
"""
983
-
interval_count: Optional[int]
984
-
"""
985
-
The multiplier applied to the interval.
986
-
"""
987
-
988
-
amendment_start: Optional[AmendmentStart]
989
-
"""
990
-
Use an index to specify the position of an amendment to start prebilling with.
991
-
"""
992
926
computed_timestamp: Optional[int]
993
927
"""
994
928
The time the billing schedule applies from.
@@ -997,39 +931,22 @@ class Relative(StripeObject):
997
931
"""
998
932
Lets you bill the period starting from a particular Quote line.
999
933
"""
1000
-
relative: Optional[Relative]
1001
-
"""
1002
-
Timestamp is calculated from the request time.
1003
-
"""
1004
934
timestamp: Optional[int]
1005
935
"""
1006
936
Use a precise Unix timestamp for prebilling to start. Must be earlier than `bill_until`.
1007
937
"""
1008
938
type: Literal[
1009
-
"amendment_start",
1010
939
"line_starts_at",
1011
-
"now",
1012
940
"pause_collection_start",
1013
941
"quote_acceptance_date",
1014
-
"relative",
1015
942
"timestamp",
1016
943
]
1017
944
"""
1018
945
Describes how the billing schedule determines the start date. Possible values are `timestamp`, `relative`, `amendment_start`, `now`, `quote_acceptance_date`, `line_starts_at`, or `pause_collection_start`.
Use an index to specify the position of an amendment to end prebilling with.
1031
-
"""
1032
-
1033
950
classDuration(StripeObject):
1034
951
interval: Literal["day", "month", "week", "year"]
1035
952
"""
@@ -1046,11 +963,7 @@ class LineEndsAt(StripeObject):
1046
963
Unique identifier for the object.
1047
964
"""
1048
965
1049
-
amendment_end: Optional[AmendmentEnd]
1050
-
"""
1051
-
Use an index to specify the position of an amendment to end prebilling with.
1052
-
"""
1053
-
computed_timestamp: int
966
+
computed_timestamp: Optional[int]
1054
967
"""
1055
968
The timestamp the billing schedule will apply until.
1056
969
"""
@@ -1067,7 +980,6 @@ class LineEndsAt(StripeObject):
1067
980
If specified, the billing schedule will apply until the specified timestamp.
1068
981
"""
1069
982
type: Literal[
1070
-
"amendment_end",
1071
983
"duration",
1072
984
"line_ends_at",
1073
985
"schedule_end",
@@ -1078,7 +990,6 @@ class LineEndsAt(StripeObject):
1078
990
Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
1079
991
"""
1080
992
_inner_class_types= {
1081
-
"amendment_end": AmendmentEnd,
1082
993
"duration": Duration,
1083
994
"line_ends_at": LineEndsAt,
1084
995
}
@@ -1092,9 +1003,6 @@ class LineEndsAt(StripeObject):
1092
1003
Specifies the start of the billing period.
1093
1004
"""
1094
1005
bill_until: BillUntil
1095
-
"""
1096
-
Specifies the end of billing period.
1097
-
"""
1098
1006
key: str
1099
1007
"""
1100
1008
Unique identifier for the billing schedule.
@@ -1133,10 +1041,10 @@ class LineEndsAt(StripeObject):
1133
1041
Behavior of the subscription schedule and underlying subscription when it ends.
1134
1042
"""
1135
1043
phase_effective_at: Optional[
1136
-
Literal["billing_period_start", "phase_start"]
1044
+
Literal["billing_period_start", "line_start"]
1137
1045
]
1138
1046
"""
1139
-
Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
1047
+
Configures how the quote handles billing for line transitions. Possible values are `line_start` (default) or `billing_period_start`. `line_start` bills based on the current state of the line, ignoring changes scheduled for future lines. `billing_period_start` bills predictively for upcoming line transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
0 commit comments