SubscriptionSummary¶

class oci.osp_gateway.models.SubscriptionSummary(**kwargs)¶

Bases: object

Subscription object which contains the common subscription data.

Attributes

`ACCOUNT_TYPE_CORPORATE`	A constant which can be used with the account_type property of a SubscriptionSummary.
`ACCOUNT_TYPE_CORPORATE_SUBMITTED`	A constant which can be used with the account_type property of a SubscriptionSummary.
`ACCOUNT_TYPE_PERSONAL`	A constant which can be used with the account_type property of a SubscriptionSummary.
`PLAN_TYPE_FREE_TIER`	A constant which can be used with the plan_type property of a SubscriptionSummary.
`PLAN_TYPE_PAYG`	A constant which can be used with the plan_type property of a SubscriptionSummary.
`UPGRADE_STATE_DETAILS_TAX_ERROR`	A constant which can be used with the upgrade_state_details property of a SubscriptionSummary.
`UPGRADE_STATE_DETAILS_UPGRADE_ERROR`	A constant which can be used with the upgrade_state_details property of a SubscriptionSummary.
`UPGRADE_STATE_ERROR`	A constant which can be used with the upgrade_state property of a SubscriptionSummary.
`UPGRADE_STATE_PROMO`	A constant which can be used with the upgrade_state property of a SubscriptionSummary.
`UPGRADE_STATE_SUBMITTED`	A constant which can be used with the upgrade_state property of a SubscriptionSummary.
`UPGRADE_STATE_UPGRADED`	A constant which can be used with the upgrade_state property of a SubscriptionSummary.
`account_type`	Gets the account_type of this SubscriptionSummary.
`bill_to_cust_account_id`	Gets the bill_to_cust_account_id of this SubscriptionSummary.
`billing_address`	Gets the billing_address of this SubscriptionSummary.
`currency_code`	Gets the currency_code of this SubscriptionSummary.
`gsi_org_code`	Gets the gsi_org_code of this SubscriptionSummary.
`id`	Gets the id of this SubscriptionSummary.
`is_intent_to_pay`	Gets the is_intent_to_pay of this SubscriptionSummary.
`language_code`	Gets the language_code of this SubscriptionSummary.
`organization_id`	Gets the organization_id of this SubscriptionSummary.
`payment_gateway`	Gets the payment_gateway of this SubscriptionSummary.
`payment_options`	Gets the payment_options of this SubscriptionSummary.
`plan_type`	Gets the plan_type of this SubscriptionSummary.
`ship_to_cust_acct_role_id`	Gets the ship_to_cust_acct_role_id of this SubscriptionSummary.
`ship_to_cust_acct_site_id`	Gets the ship_to_cust_acct_site_id of this SubscriptionSummary.
`subscription_plan_number`	[Required] Gets the subscription_plan_number of this SubscriptionSummary.
`tax_info`	Gets the tax_info of this SubscriptionSummary.
`time_personal_to_corporate_conv`	Gets the time_personal_to_corporate_conv of this SubscriptionSummary.
`time_plan_upgrade`	Gets the time_plan_upgrade of this SubscriptionSummary.
`time_start`	Gets the time_start of this SubscriptionSummary.
`upgrade_state`	Gets the upgrade_state of this SubscriptionSummary.
`upgrade_state_details`	Gets the upgrade_state_details of this SubscriptionSummary.

Methods

__init__(**kwargs) Initializes a new SubscriptionSummary object with values from keyword arguments.

ACCOUNT_TYPE_CORPORATE = 'CORPORATE'¶: A constant which can be used with the account_type property of a SubscriptionSummary. This constant has a value of “CORPORATE”

ACCOUNT_TYPE_CORPORATE_SUBMITTED = 'CORPORATE_SUBMITTED'¶: A constant which can be used with the account_type property of a SubscriptionSummary. This constant has a value of “CORPORATE_SUBMITTED”

ACCOUNT_TYPE_PERSONAL = 'PERSONAL'¶: A constant which can be used with the account_type property of a SubscriptionSummary. This constant has a value of “PERSONAL”

PLAN_TYPE_FREE_TIER = 'FREE_TIER'¶: A constant which can be used with the plan_type property of a SubscriptionSummary. This constant has a value of “FREE_TIER”

PLAN_TYPE_PAYG = 'PAYG'¶: A constant which can be used with the plan_type property of a SubscriptionSummary. This constant has a value of “PAYG”

UPGRADE_STATE_DETAILS_TAX_ERROR = 'TAX_ERROR'¶: A constant which can be used with the upgrade_state_details property of a SubscriptionSummary. This constant has a value of “TAX_ERROR”

UPGRADE_STATE_DETAILS_UPGRADE_ERROR = 'UPGRADE_ERROR'¶: A constant which can be used with the upgrade_state_details property of a SubscriptionSummary. This constant has a value of “UPGRADE_ERROR”

UPGRADE_STATE_ERROR = 'ERROR'¶: A constant which can be used with the upgrade_state property of a SubscriptionSummary. This constant has a value of “ERROR”

UPGRADE_STATE_PROMO = 'PROMO'¶: A constant which can be used with the upgrade_state property of a SubscriptionSummary. This constant has a value of “PROMO”

UPGRADE_STATE_SUBMITTED = 'SUBMITTED'¶: A constant which can be used with the upgrade_state property of a SubscriptionSummary. This constant has a value of “SUBMITTED”

UPGRADE_STATE_UPGRADED = 'UPGRADED'¶: A constant which can be used with the upgrade_state property of a SubscriptionSummary. This constant has a value of “UPGRADED”

__init__(**kwargs)¶

Initializes a new SubscriptionSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this SubscriptionSummary.
subscription_plan_number (str) – The value to assign to the subscription_plan_number property of this SubscriptionSummary.
plan_type (str) – The value to assign to the plan_type property of this SubscriptionSummary. Allowed values for this property are: “FREE_TIER”, “PAYG”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_start (datetime) – The value to assign to the time_start property of this SubscriptionSummary.
ship_to_cust_acct_site_id (str) – The value to assign to the ship_to_cust_acct_site_id property of this SubscriptionSummary.
ship_to_cust_acct_role_id (str) – The value to assign to the ship_to_cust_acct_role_id property of this SubscriptionSummary.
bill_to_cust_account_id (str) – The value to assign to the bill_to_cust_account_id property of this SubscriptionSummary.
is_intent_to_pay (bool) – The value to assign to the is_intent_to_pay property of this SubscriptionSummary.
currency_code (str) – The value to assign to the currency_code property of this SubscriptionSummary.
gsi_org_code (str) – The value to assign to the gsi_org_code property of this SubscriptionSummary.
language_code (str) – The value to assign to the language_code property of this SubscriptionSummary.
organization_id (str) – The value to assign to the organization_id property of this SubscriptionSummary.
upgrade_state (str) – The value to assign to the upgrade_state property of this SubscriptionSummary. Allowed values for this property are: “PROMO”, “SUBMITTED”, “ERROR”, “UPGRADED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
upgrade_state_details (str) – The value to assign to the upgrade_state_details property of this SubscriptionSummary. Allowed values for this property are: “TAX_ERROR”, “UPGRADE_ERROR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
account_type (str) – The value to assign to the account_type property of this SubscriptionSummary. Allowed values for this property are: “PERSONAL”, “CORPORATE”, “CORPORATE_SUBMITTED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
tax_info (oci.osp_gateway.models.TaxInfo) – The value to assign to the tax_info property of this SubscriptionSummary.
payment_options (list[oci.osp_gateway.models.PaymentOption]) – The value to assign to the payment_options property of this SubscriptionSummary.
payment_gateway (oci.osp_gateway.models.PaymentGateway) – The value to assign to the payment_gateway property of this SubscriptionSummary.
billing_address (oci.osp_gateway.models.Address) – The value to assign to the billing_address property of this SubscriptionSummary.
time_plan_upgrade (datetime) – The value to assign to the time_plan_upgrade property of this SubscriptionSummary.
time_personal_to_corporate_conv (datetime) – The value to assign to the time_personal_to_corporate_conv property of this SubscriptionSummary.

account_type¶

Gets the account_type of this SubscriptionSummary. Account type.

Allowed values for this property are: “PERSONAL”, “CORPORATE”, “CORPORATE_SUBMITTED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The account_type of this SubscriptionSummary.
Return type:	str

bill_to_cust_account_id¶

Gets the bill_to_cust_account_id of this SubscriptionSummary. Bill to customer Account id.

Returns:	The bill_to_cust_account_id of this SubscriptionSummary.
Return type:	str

billing_address¶

Gets the billing_address of this SubscriptionSummary.

Returns:	The billing_address of this SubscriptionSummary.
Return type:	oci.osp_gateway.models.Address

currency_code¶

Gets the currency_code of this SubscriptionSummary. Currency code

Returns:	The currency_code of this SubscriptionSummary.
Return type:	str

gsi_org_code¶

Gets the gsi_org_code of this SubscriptionSummary. GSI Subscription external code.

Returns:	The gsi_org_code of this SubscriptionSummary.
Return type:	str

id¶

Gets the id of this SubscriptionSummary. Subscription id identifier (OCID).

Returns:	The id of this SubscriptionSummary.
Return type:	str

is_intent_to_pay¶

Gets the is_intent_to_pay of this SubscriptionSummary. Payment intension.

Returns:	The is_intent_to_pay of this SubscriptionSummary.
Return type:	bool

language_code¶

Gets the language_code of this SubscriptionSummary. Language short code (en, de, hu, etc)

Returns:	The language_code of this SubscriptionSummary.
Return type:	str

organization_id¶

Gets the organization_id of this SubscriptionSummary. GSI organization external identifier.

Returns:	The organization_id of this SubscriptionSummary.
Return type:	str

payment_gateway¶

Gets the payment_gateway of this SubscriptionSummary.

Returns:	The payment_gateway of this SubscriptionSummary.
Return type:	oci.osp_gateway.models.PaymentGateway

payment_options¶

Gets the payment_options of this SubscriptionSummary. Payment option list of a subscription.

Returns:	The payment_options of this SubscriptionSummary.
Return type:	list[oci.osp_gateway.models.PaymentOption]

plan_type¶

Gets the plan_type of this SubscriptionSummary. Subscription plan type.

Allowed values for this property are: “FREE_TIER”, “PAYG”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The plan_type of this SubscriptionSummary.
Return type:	str

ship_to_cust_acct_role_id¶

Gets the ship_to_cust_acct_role_id of this SubscriptionSummary. Ship to customer account role.

Returns:	The ship_to_cust_acct_role_id of this SubscriptionSummary.
Return type:	str

ship_to_cust_acct_site_id¶

Gets the ship_to_cust_acct_site_id of this SubscriptionSummary. Ship to customer account site address id.

Returns:	The ship_to_cust_acct_site_id of this SubscriptionSummary.
Return type:	str

subscription_plan_number¶

[Required] Gets the subscription_plan_number of this SubscriptionSummary. Subscription plan number.

Returns:	The subscription_plan_number of this SubscriptionSummary.
Return type:	str

tax_info¶

Gets the tax_info of this SubscriptionSummary.

Returns:	The tax_info of this SubscriptionSummary.
Return type:	oci.osp_gateway.models.TaxInfo

time_personal_to_corporate_conv¶

Gets the time_personal_to_corporate_conv of this SubscriptionSummary. Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE

Returns:	The time_personal_to_corporate_conv of this SubscriptionSummary.
Return type:	datetime

time_plan_upgrade¶

Gets the time_plan_upgrade of this SubscriptionSummary. Date of upgrade/conversion when planType changed from FREE_TIER to PAYG

Returns:	The time_plan_upgrade of this SubscriptionSummary.
Return type:	datetime

time_start¶

Gets the time_start of this SubscriptionSummary. Start date of the subscription.

Returns:	The time_start of this SubscriptionSummary.
Return type:	datetime

upgrade_state¶

Gets the upgrade_state of this SubscriptionSummary. Status of the upgrade.

Allowed values for this property are: “PROMO”, “SUBMITTED”, “ERROR”, “UPGRADED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The upgrade_state of this SubscriptionSummary.
Return type:	str

upgrade_state_details¶

Gets the upgrade_state_details of this SubscriptionSummary. This field is used to describe the Upgrade State in case of error (E.g. Upgrade failure caused by interfacing Tax details- TaxError)

Allowed values for this property are: “TAX_ERROR”, “UPGRADE_ERROR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The upgrade_state_details of this SubscriptionSummary.
Return type:	str