Skip to content

Commit 1e4d614

Browse files
feat(api): updates (#73)
1 parent e7f7b47 commit 1e4d614

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

src/orb/types/invoice.py

+20
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
"LineItemTaxAmount",
3434
"Maximum",
3535
"Minimum",
36+
"Plan",
3637
"ShippingAddress",
3738
"Subscription",
3839
]
@@ -695,6 +696,19 @@ class Minimum(BaseModel):
695696
"""Minimum amount applied"""
696697

697698

699+
class Plan(BaseModel):
700+
id: Optional[str]
701+
702+
external_plan_id: Optional[str]
703+
"""
704+
An optional user-defined ID for this plan resource, used throughout the system
705+
as an alias for this Plan. Use this field to identify a plan by an existing
706+
identifier in your system.
707+
"""
708+
709+
name: Optional[str]
710+
711+
698712
class ShippingAddress(BaseModel):
699713
city: Optional[str]
700714

@@ -912,6 +926,12 @@ class Invoice(BaseModel):
912926
payment mechanisms (like bank transfers), where payment can take 3 days or more.
913927
"""
914928

929+
plan: Optional[Plan]
930+
"""The active plan for this invoice's subscription on its invoice date.
931+
932+
This field is only populated for invoices generated by subscriptions.
933+
"""
934+
915935
scheduled_issue_at: Optional[datetime]
916936
"""
917937
If the invoice is in draft, this timestamp will reflect when the invoice is

src/orb/types/invoice_fetch_upcoming_response.py

+20
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
"LineItemTaxAmount",
3434
"Maximum",
3535
"Minimum",
36+
"Plan",
3637
"ShippingAddress",
3738
"Subscription",
3839
]
@@ -695,6 +696,19 @@ class Minimum(BaseModel):
695696
"""Minimum amount applied"""
696697

697698

699+
class Plan(BaseModel):
700+
id: Optional[str]
701+
702+
external_plan_id: Optional[str]
703+
"""
704+
An optional user-defined ID for this plan resource, used throughout the system
705+
as an alias for this Plan. Use this field to identify a plan by an existing
706+
identifier in your system.
707+
"""
708+
709+
name: Optional[str]
710+
711+
698712
class ShippingAddress(BaseModel):
699713
city: Optional[str]
700714

@@ -909,6 +923,12 @@ class InvoiceFetchUpcomingResponse(BaseModel):
909923
payment mechanisms (like bank transfers), where payment can take 3 days or more.
910924
"""
911925

926+
plan: Optional[Plan]
927+
"""The active plan for this invoice's subscription on its invoice date.
928+
929+
This field is only populated for invoices generated by subscriptions.
930+
"""
931+
912932
scheduled_issue_at: Optional[datetime]
913933
"""
914934
If the invoice is in draft, this timestamp will reflect when the invoice is

0 commit comments

Comments
 (0)