lark-billing 0.0.8__tar.gz → 0.0.9__tar.gz

{lark_billing-0.0.8 → lark_billing-0.0.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lark-billing
-Version: 0.0.8
+Version: 0.0.9
 Summary: 
 Requires-Python: >=3.8,<4.0
 Classifier: Intended Audience :: Developers
@@ -53,8 +53,8 @@ client = Lark(
     api_key="YOUR_API_KEY",
 )
 client.checkout.create_subscription_checkout_session(
-    subject_id="subject_id",
-    rate_card_id="rate_card_id",
+    subject_id="subj_VyX6Q96h5avMho8O7QWlKeXE",
+    rate_card_id="rc_AJWMxR81jxoRlli6p13uf3JB",
     success_callback_url="https://example.com/callback",
 )
 ```
@@ -75,8 +75,8 @@ client = AsyncLark(
 
 async def main() -> None:
     await client.checkout.create_subscription_checkout_session(
-        subject_id="subject_id",
-        rate_card_id="rate_card_id",
+        subject_id="subj_VyX6Q96h5avMho8O7QWlKeXE",
+        rate_card_id="rc_AJWMxR81jxoRlli6p13uf3JB",
         success_callback_url="https://example.com/callback",
     )
 

{lark_billing-0.0.8 → lark_billing-0.0.9}/README.md

@@ -26,8 +26,8 @@ client = Lark(
     api_key="YOUR_API_KEY",
 )
 client.checkout.create_subscription_checkout_session(
-    subject_id="subject_id",
-    rate_card_id="rate_card_id",
+    subject_id="subj_VyX6Q96h5avMho8O7QWlKeXE",
+    rate_card_id="rc_AJWMxR81jxoRlli6p13uf3JB",
     success_callback_url="https://example.com/callback",
 )
 ```
@@ -48,8 +48,8 @@ client = AsyncLark(
 
 async def main() -> None:
     await client.checkout.create_subscription_checkout_session(
-        subject_id="subject_id",
-        rate_card_id="rate_card_id",
+        subject_id="subj_VyX6Q96h5avMho8O7QWlKeXE",
+        rate_card_id="rc_AJWMxR81jxoRlli6p13uf3JB",
         success_callback_url="https://example.com/callback",
     )
 

{lark_billing-0.0.8 → lark_billing-0.0.9}/pyproject.toml

@@ -3,7 +3,7 @@ name = "lark-billing"
 
 [tool.poetry]
 name = "lark-billing"
-version = "0.0.8"
+version = "0.0.9"
 description = ""
 readme = "README.md"
 authors = []

{lark_billing-0.0.8 → lark_billing-0.0.9}/src/lark/__init__.py

@@ -76,7 +76,7 @@ if typing.TYPE_CHECKING:
         CreateRateCardRequestUsageBasedRatesItem,
         CreateRateCardRequestUsageBasedRatesItem_Simple,
     )
-    from .usage_events import CreateUsageEventSummaryRequestAggregationType
+    from .usage_events import CreateUsageEventRequestDataValue, CreateUsageEventSummaryRequestAggregationType
     from .version import __version__
 _dynamic_imports: typing.Dict[str, str] = {
     "Aggregation": ".types",
@@ -96,6 +96,7 @@ _dynamic_imports: typing.Dict[str, str] = {
     "CreateSimpleUsageBasedRateRequest": ".types",
     "CreateSubjectResponse": ".types",
     "CreateSubscriptionCheckoutSessionResponse": ".types",
+    "CreateUsageEventRequestDataValue": ".usage_events",
     "CreateUsageEventSummaryRequestAggregationType": ".usage_events",
     "CreateUsageEventSummaryResponse": ".types",
     "FixedRateInterface": ".types",
@@ -190,6 +191,7 @@ __all__ = [
     "CreateSimpleUsageBasedRateRequest",
     "CreateSubjectResponse",
     "CreateSubscriptionCheckoutSessionResponse",
+    "CreateUsageEventRequestDataValue",
     "CreateUsageEventSummaryRequestAggregationType",
     "CreateUsageEventSummaryResponse",
     "FixedRateInterface",

{lark_billing-0.0.8 → lark_billing-0.0.9}/src/lark/checkout/client.py

@@ -39,8 +39,10 @@ class CheckoutClient:
         Parameters
         ----------
         subject_id : str
+            The ID of the subject to create the checkout for.
 
         rate_card_id : str
+            The ID of the rate card to subscribe to.
 
         success_callback_url : str
             The URL to redirect to after the checkout is successful.
@@ -64,8 +66,8 @@ class CheckoutClient:
             api_key="YOUR_API_KEY",
         )
         client.checkout.create_subscription_checkout_session(
-            subject_id="subject_id",
-            rate_card_id="rate_card_id",
+            subject_id="subj_VyX6Q96h5avMho8O7QWlKeXE",
+            rate_card_id="rc_AJWMxR81jxoRlli6p13uf3JB",
             success_callback_url="https://example.com/callback",
         )
         """
@@ -107,8 +109,10 @@ class AsyncCheckoutClient:
         Parameters
         ----------
         subject_id : str
+            The ID of the subject to create the checkout for.
 
         rate_card_id : str
+            The ID of the rate card to subscribe to.
 
         success_callback_url : str
             The URL to redirect to after the checkout is successful.
@@ -137,8 +141,8 @@ class AsyncCheckoutClient:
 
         async def main() -> None:
             await client.checkout.create_subscription_checkout_session(
-                subject_id="subject_id",
-                rate_card_id="rate_card_id",
+                subject_id="subj_VyX6Q96h5avMho8O7QWlKeXE",
+                rate_card_id="rc_AJWMxR81jxoRlli6p13uf3JB",
                 success_callback_url="https://example.com/callback",
             )
 

{lark_billing-0.0.8 → lark_billing-0.0.9}/src/lark/checkout/raw_client.py

@@ -33,8 +33,10 @@ class RawCheckoutClient:
         Parameters
         ----------
         subject_id : str
+            The ID of the subject to create the checkout for.
 
         rate_card_id : str
+            The ID of the rate card to subscribe to.
 
         success_callback_url : str
             The URL to redirect to after the checkout is successful.
@@ -109,8 +111,10 @@ class AsyncRawCheckoutClient:
         Parameters
         ----------
         subject_id : str
+            The ID of the subject to create the checkout for.
 
         rate_card_id : str
+            The ID of the rate card to subscribe to.
 
         success_callback_url : str
             The URL to redirect to after the checkout is successful.

{lark_billing-0.0.8 → lark_billing-0.0.9}/src/lark/core/client_wrapper.py

@@ -22,10 +22,10 @@ class BaseClientWrapper:
 
     def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
-            "User-Agent": "lark-billing/0.0.8",
+            "User-Agent": "lark-billing/0.0.9",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "lark-billing",
-            "X-Fern-SDK-Version": "0.0.8",
+            "X-Fern-SDK-Version": "0.0.9",
             **(self.get_custom_headers() or {}),
         }
         headers["X-API-Key"] = self.api_key

{lark_billing-0.0.8 → lark_billing-0.0.9}/src/lark/customer_portal/client.py

@@ -33,6 +33,7 @@ class CustomerPortalClient:
         Parameters
         ----------
         subject_id : str
+            The ID of the subject to create the customer portal session for.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -50,7 +51,7 @@ class CustomerPortalClient:
             api_key="YOUR_API_KEY",
         )
         client.customer_portal.create_customer_portal_session(
-            subject_id="subject_id",
+            subject_id="subj_VyX6Q96h5avMho8O7QWlKeXE",
         )
         """
         _response = self._raw_client.create_customer_portal_session(
@@ -81,6 +82,7 @@ class AsyncCustomerPortalClient:
         Parameters
         ----------
         subject_id : str
+            The ID of the subject to create the customer portal session for.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -103,7 +105,7 @@ class AsyncCustomerPortalClient:
 
         async def main() -> None:
             await client.customer_portal.create_customer_portal_session(
-                subject_id="subject_id",
+                subject_id="subj_VyX6Q96h5avMho8O7QWlKeXE",
             )
 
 

{lark_billing-0.0.8 → lark_billing-0.0.9}/src/lark/customer_portal/raw_client.py

@@ -27,6 +27,7 @@ class RawCustomerPortalClient:
         Parameters
         ----------
         subject_id : str
+            The ID of the subject to create the customer portal session for.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -86,6 +87,7 @@ class AsyncRawCustomerPortalClient:
         Parameters
         ----------
         subject_id : str
+            The ID of the subject to create the customer portal session for.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.

{lark_billing-0.0.8 → lark_billing-0.0.9}/src/lark/rate_cards/client.py

@@ -66,8 +66,8 @@ class RateCardsClient:
         name: str,
         billing_interval: CreateRateCardRequestBillingInterval,
         description: typing.Optional[str] = OMIT,
-        usage_based_rates: typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]] = OMIT,
         fixed_rates: typing.Optional[typing.Sequence[CreateFixedRateRequest]] = OMIT,
+        usage_based_rates: typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]] = OMIT,
         metadata: typing.Optional[typing.Dict[str, str]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> RateCardResource:
@@ -75,15 +75,18 @@ class RateCardsClient:
         Parameters
         ----------
         name : str
+            The name of the rate card displayed to the customer.
 
         billing_interval : CreateRateCardRequestBillingInterval
+            How often the customer will be billed for this rate card.
 
         description : typing.Optional[str]
-
-        usage_based_rates : typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]]
+            The description of the rate card displayed to the customer.
 
         fixed_rates : typing.Optional[typing.Sequence[CreateFixedRateRequest]]
 
+        usage_based_rates : typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]]
+
         metadata : typing.Optional[typing.Dict[str, str]]
 
         request_options : typing.Optional[RequestOptions]
@@ -102,7 +105,7 @@ class RateCardsClient:
             api_key="YOUR_API_KEY",
         )
         client.rate_cards.create_rate_card(
-            name="name",
+            name="Pro Plan",
             billing_interval="monthly",
         )
         """
@@ -110,8 +113,8 @@ class RateCardsClient:
             name=name,
             billing_interval=billing_interval,
             description=description,
-            usage_based_rates=usage_based_rates,
             fixed_rates=fixed_rates,
+            usage_based_rates=usage_based_rates,
             metadata=metadata,
             request_options=request_options,
         )
@@ -207,8 +210,8 @@ class AsyncRateCardsClient:
         name: str,
         billing_interval: CreateRateCardRequestBillingInterval,
         description: typing.Optional[str] = OMIT,
-        usage_based_rates: typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]] = OMIT,
         fixed_rates: typing.Optional[typing.Sequence[CreateFixedRateRequest]] = OMIT,
+        usage_based_rates: typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]] = OMIT,
         metadata: typing.Optional[typing.Dict[str, str]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> RateCardResource:
@@ -216,15 +219,18 @@ class AsyncRateCardsClient:
         Parameters
         ----------
         name : str
+            The name of the rate card displayed to the customer.
 
         billing_interval : CreateRateCardRequestBillingInterval
+            How often the customer will be billed for this rate card.
 
         description : typing.Optional[str]
-
-        usage_based_rates : typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]]
+            The description of the rate card displayed to the customer.
 
         fixed_rates : typing.Optional[typing.Sequence[CreateFixedRateRequest]]
 
+        usage_based_rates : typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]]
+
         metadata : typing.Optional[typing.Dict[str, str]]
 
         request_options : typing.Optional[RequestOptions]
@@ -248,7 +254,7 @@ class AsyncRateCardsClient:
 
         async def main() -> None:
             await client.rate_cards.create_rate_card(
-                name="name",
+                name="Pro Plan",
                 billing_interval="monthly",
             )
 
@@ -259,8 +265,8 @@ class AsyncRateCardsClient:
             name=name,
             billing_interval=billing_interval,
             description=description,
-            usage_based_rates=usage_based_rates,
             fixed_rates=fixed_rates,
+            usage_based_rates=usage_based_rates,
             metadata=metadata,
             request_options=request_options,
         )

{lark_billing-0.0.8 → lark_billing-0.0.9}/src/lark/rate_cards/raw_client.py

@@ -82,8 +82,8 @@ class RawRateCardsClient:
         name: str,
         billing_interval: CreateRateCardRequestBillingInterval,
         description: typing.Optional[str] = OMIT,
-        usage_based_rates: typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]] = OMIT,
         fixed_rates: typing.Optional[typing.Sequence[CreateFixedRateRequest]] = OMIT,
+        usage_based_rates: typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]] = OMIT,
         metadata: typing.Optional[typing.Dict[str, str]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[RateCardResource]:
@@ -91,15 +91,18 @@ class RawRateCardsClient:
         Parameters
         ----------
         name : str
+            The name of the rate card displayed to the customer.
 
         billing_interval : CreateRateCardRequestBillingInterval
+            How often the customer will be billed for this rate card.
 
         description : typing.Optional[str]
-
-        usage_based_rates : typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]]
+            The description of the rate card displayed to the customer.
 
         fixed_rates : typing.Optional[typing.Sequence[CreateFixedRateRequest]]
 
+        usage_based_rates : typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]]
+
         metadata : typing.Optional[typing.Dict[str, str]]
 
         request_options : typing.Optional[RequestOptions]
@@ -116,15 +119,15 @@ class RawRateCardsClient:
             json={
                 "name": name,
                 "description": description,
+                "billing_interval": billing_interval,
+                "fixed_rates": convert_and_respect_annotation_metadata(
+                    object_=fixed_rates, annotation=typing.Sequence[CreateFixedRateRequest], direction="write"
+                ),
                 "usage_based_rates": convert_and_respect_annotation_metadata(
                     object_=usage_based_rates,
                     annotation=typing.Sequence[CreateRateCardRequestUsageBasedRatesItem],
                     direction="write",
                 ),
-                "fixed_rates": convert_and_respect_annotation_metadata(
-                    object_=fixed_rates, annotation=typing.Sequence[CreateFixedRateRequest], direction="write"
-                ),
-                "billing_interval": billing_interval,
                 "metadata": metadata,
             },
             headers={
@@ -267,8 +270,8 @@ class AsyncRawRateCardsClient:
         name: str,
         billing_interval: CreateRateCardRequestBillingInterval,
         description: typing.Optional[str] = OMIT,
-        usage_based_rates: typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]] = OMIT,
         fixed_rates: typing.Optional[typing.Sequence[CreateFixedRateRequest]] = OMIT,
+        usage_based_rates: typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]] = OMIT,
         metadata: typing.Optional[typing.Dict[str, str]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[RateCardResource]:
@@ -276,15 +279,18 @@ class AsyncRawRateCardsClient:
         Parameters
         ----------
         name : str
+            The name of the rate card displayed to the customer.
 
         billing_interval : CreateRateCardRequestBillingInterval
+            How often the customer will be billed for this rate card.
 
         description : typing.Optional[str]
-
-        usage_based_rates : typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]]
+            The description of the rate card displayed to the customer.
 
         fixed_rates : typing.Optional[typing.Sequence[CreateFixedRateRequest]]
 
+        usage_based_rates : typing.Optional[typing.Sequence[CreateRateCardRequestUsageBasedRatesItem]]
+
         metadata : typing.Optional[typing.Dict[str, str]]
 
         request_options : typing.Optional[RequestOptions]
@@ -301,15 +307,15 @@ class AsyncRawRateCardsClient:
             json={
                 "name": name,
                 "description": description,
+                "billing_interval": billing_interval,
+                "fixed_rates": convert_and_respect_annotation_metadata(
+                    object_=fixed_rates, annotation=typing.Sequence[CreateFixedRateRequest], direction="write"
+                ),
                 "usage_based_rates": convert_and_respect_annotation_metadata(
                     object_=usage_based_rates,
                     annotation=typing.Sequence[CreateRateCardRequestUsageBasedRatesItem],
                     direction="write",
                 ),
-                "fixed_rates": convert_and_respect_annotation_metadata(
-                    object_=fixed_rates, annotation=typing.Sequence[CreateFixedRateRequest], direction="write"
-                ),
-                "billing_interval": billing_interval,
                 "metadata": metadata,
             },
             headers={

{lark_billing-0.0.8 → lark_billing-0.0.9}/src/lark/rate_cards/types/create_rate_card_request_usage_based_rates_item.py

@@ -11,7 +11,7 @@ from ...types.price import Price
 
 class CreateRateCardRequestUsageBasedRatesItem_Simple(UniversalBaseModel):
     usage_based_rate_type: typing.Literal["simple"] = "simple"
-    name: typing.Optional[str] = None
+    name: str
     description: typing.Optional[str] = None
     price: Price
     included_units: typing.Optional[int] = None

{lark_billing-0.0.8 → lark_billing-0.0.9}/src/lark/subscriptions/client.py

@@ -202,6 +202,7 @@ class SubscriptionsClient:
         subscription_id : str
 
         rate_card_id : str
+            The ID of the rate card to change the subscription to.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -220,7 +221,7 @@ class SubscriptionsClient:
         )
         client.subscriptions.change_subscription_rate_card(
             subscription_id="subscription_id",
-            rate_card_id="rc_AJWMxR81jxoRlli6p13uf3JB",
+            rate_card_id="rc_jQK2n0wutCj6bBcAIrL6o07g",
         )
         """
         _response = self._raw_client.change_subscription_rate_card(
@@ -451,6 +452,7 @@ class AsyncSubscriptionsClient:
         subscription_id : str
 
         rate_card_id : str
+            The ID of the rate card to change the subscription to.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -474,7 +476,7 @@ class AsyncSubscriptionsClient:
         async def main() -> None:
             await client.subscriptions.change_subscription_rate_card(
                 subscription_id="subscription_id",
-                rate_card_id="rc_AJWMxR81jxoRlli6p13uf3JB",
+                rate_card_id="rc_jQK2n0wutCj6bBcAIrL6o07g",
             )
 
 

{lark_billing-0.0.8 → lark_billing-0.0.9}/src/lark/subscriptions/raw_client.py

@@ -275,6 +275,7 @@ class RawSubscriptionsClient:
         subscription_id : str
 
         rate_card_id : str
+            The ID of the rate card to change the subscription to.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -580,6 +581,7 @@ class AsyncRawSubscriptionsClient:
         subscription_id : str
 
         rate_card_id : str
+            The ID of the rate card to change the subscription to.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.

{lark_billing-0.0.8 → lark_billing-0.0.9}/src/lark/types/amount.py

@@ -12,7 +12,10 @@ class Amount(UniversalBaseModel):
     The value of the amount in the smallest unit of the currency.
     """
 
-    currency_code: str
+    currency_code: str = pydantic.Field()
+    """
+    The currency code of the amount.
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

{lark_billing-0.0.8 → lark_billing-0.0.9}/src/lark/types/create_customer_portal_session_response.py

@@ -7,8 +7,15 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class CreateCustomerPortalSessionResponse(UniversalBaseModel):
-    subject_id: str
-    url: str
+    subject_id: str = pydantic.Field()
+    """
+    The ID of the subject for the customer portal session.
+    """
+
+    url: str = pydantic.Field()
+    """
+    The URL to redirect to the customer portal session.
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

{lark_billing-0.0.8 → lark_billing-0.0.9}/src/lark/types/create_fixed_rate_request.py

@@ -8,8 +8,16 @@ from .price import Price
 
 
 class CreateFixedRateRequest(UniversalBaseModel):
-    name: typing.Optional[str] = None
-    description: typing.Optional[str] = None
+    name: str = pydantic.Field()
+    """
+    The name of the rate displayed to the customer.
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The description of the rate displayed to the customer.
+    """
+
     price: Price
 
     if IS_PYDANTIC_V2:

{lark_billing-0.0.8 → lark_billing-0.0.9}/src/lark/types/create_simple_usage_based_rate_request.py

@@ -8,10 +8,22 @@ from .price import Price
 
 
 class CreateSimpleUsageBasedRateRequest(UniversalBaseModel):
-    name: typing.Optional[str] = None
-    description: typing.Optional[str] = None
+    name: str = pydantic.Field()
+    """
+    The name of the rate displayed to the customer.
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The description of the rate displayed to the customer.
+    """
+
     price: Price
-    included_units: typing.Optional[int] = None
+    included_units: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    The number of units included in the rate before the price is applied.
+    """
+
     pricing_metric_id: str = pydantic.Field()
     """
     The ID of the pricing metric to use for this rate.

{lark_billing-0.0.8 → lark_billing-0.0.9}/src/lark/types/create_subscription_checkout_session_response.py

@@ -8,9 +8,20 @@ from .amount import Amount
 
 
 class CreateSubscriptionCheckoutSessionResponse(UniversalBaseModel):
-    id: str
-    amount: Amount
-    url: str
+    id: str = pydantic.Field()
+    """
+    The ID of the checkout session.
+    """
+
+    amount: Amount = pydantic.Field()
+    """
+    The amount of the checkout session.
+    """
+
+    url: str = pydantic.Field()
+    """
+    The URL to redirect to the checkout session.
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

{lark_billing-0.0.8 → lark_billing-0.0.9}/src/lark/types/fixed_rate_interface.py

@@ -10,7 +10,7 @@ from .price import Price
 class FixedRateInterface(UniversalBaseModel):
     id: str
     name: str
-    description: str
+    description: typing.Optional[str] = None
     price: Price
 
     if IS_PYDANTIC_V2:

lark_billing-0.0.9/src/lark/types/invoice_resource.py

@@ -0,0 +1,56 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .amount import Amount
+from .invoice_line_item_resource import InvoiceLineItemResource
+from .invoice_status import InvoiceStatus
+
+
+class InvoiceResource(UniversalBaseModel):
+    id: str = pydantic.Field()
+    """
+    The ID of the invoice.
+    """
+
+    total_amount: Amount = pydantic.Field()
+    """
+    The total amount of the invoice.
+    """
+
+    subject_id: str = pydantic.Field()
+    """
+    The ID of the subject for the invoice.
+    """
+
+    created_at: dt.datetime = pydantic.Field()
+    """
+    The date and time the invoice was created.
+    """
+
+    status: InvoiceStatus = pydantic.Field()
+    """
+    The status of the invoice.
+    """
+
+    hosted_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The URL of the hosted invoice.
+    """
+
+    line_items: typing.List[InvoiceLineItemResource] = pydantic.Field()
+    """
+    The line items of the invoice.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow