Skip to content

Subscription

Source code in docs_src/capo_outposts/types/subscription.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
class Subscription(TypedDict, closed=True):
    subscription_id: NotRequired["capo_outposts.types.string.String"]
    """<p>The ID of the subscription that appears on the Amazon Web Services Billing Center console.</p>"""
    subscription_type: NotRequired[
        "capo_outposts.types.subscription_type.SubscriptionType"
    ]
    """<p>The type of subscription which can be one of the following:</p> <ul> <li> <p> <b>ORIGINAL</b> - The first order on the Amazon Web Services Outposts.</p> </li> <li> <p> <b>RENEWAL</b> - Renewal requests, both month to month and longer term.</p> </li> <li> <p> <b>CAPACITY_INCREASE</b> - Capacity scaling orders.</p> </li> </ul>"""
    subscription_status: NotRequired[
        "capo_outposts.types.subscription_status.SubscriptionStatus"
    ]
    """<p>The status of subscription which can be one of the following:</p> <ul> <li> <p> <b>INACTIVE</b> - Subscription requests that are inactive.</p> </li> <li> <p> <b>ACTIVE</b> - Subscription requests that are in progress and have an end date in the future.</p> </li> <li> <p> <b>PENDING</b> - Subscription has been created but billing has not yet commenced because the subscription begin date has not been reached.</p> </li> <li> <p> <b>CANCELLED</b> - Subscription requests that are cancelled.</p> </li> </ul>"""
    order_ids: NotRequired["capo_outposts.types.order_id_list.OrderIdList"]
    """<p>The order ID for your subscription.</p>"""
    begin_date: NotRequired["capo_outposts.types.iso8601_timestamp.ISO8601Timestamp"]
    """<p>The date your subscription starts.</p>"""
    end_date: NotRequired["capo_outposts.types.iso8601_timestamp.ISO8601Timestamp"]
    """<p>The date your subscription ends.</p>"""
    currency: NotRequired["capo_outposts.types.currency_code.CurrencyCode"]
    """<p>The currency of the subscription price. Currently only <code>USD</code> is supported.</p>"""
    monthly_recurring_price: NotRequired[
        "capo_outposts.types.nullable_double.NullableDouble"
    ]
    """<p>The amount you are billed each month in the subscription period.</p>"""
    upfront_price: NotRequired["capo_outposts.types.nullable_double.NullableDouble"]
    """<p>The amount billed when the subscription is created. This is a one-time charge.</p>"""

begin_date instance-attribute 

begin_date: NotRequired[ISO8601Timestamp]

The date your subscription starts.

currency instance-attribute 

currency: NotRequired[CurrencyCode]

The currency of the subscription price. Currently only USD is supported.

end_date instance-attribute 

end_date: NotRequired[ISO8601Timestamp]

The date your subscription ends.

monthly_recurring_price instance-attribute 

monthly_recurring_price: NotRequired[NullableDouble]

The amount you are billed each month in the subscription period.

order_ids instance-attribute 

order_ids: NotRequired[OrderIdList]

The order ID for your subscription.

subscription_id instance-attribute 

subscription_id: NotRequired[String]

The ID of the subscription that appears on the Amazon Web Services Billing Center console.

subscription_status instance-attribute 

subscription_status: NotRequired[SubscriptionStatus]

The status of subscription which can be one of the following:

  • INACTIVE - Subscription requests that are inactive.

  • ACTIVE - Subscription requests that are in progress and have an end date in the future.

  • PENDING - Subscription has been created but billing has not yet commenced because the subscription begin date has not been reached.

  • CANCELLED - Subscription requests that are cancelled.

subscription_type instance-attribute 

subscription_type: NotRequired[SubscriptionType]

The type of subscription which can be one of the following:

  • ORIGINAL - The first order on the Amazon Web Services Outposts.

  • RENEWAL - Renewal requests, both month to month and longer term.

  • CAPACITY_INCREASE - Capacity scaling orders.

upfront_price instance-attribute 

upfront_price: NotRequired[NullableDouble]

The amount billed when the subscription is created. This is a one-time charge.