Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace SubscriptionSummary

Subscription object which contains the common subscription data.

Properties

Optional accountType

accountType: AccountType

Account type.

Optional billToCustAccountId

billToCustAccountId: undefined | string

Bill to customer Account id.

Optional billingAddress

billingAddress: model.Address

Optional currencyCode

currencyCode: undefined | string

Currency code

Optional gsiOrgCode

gsiOrgCode: undefined | string

GSI Subscription external code.

Optional id

id: undefined | string

Subscription id identifier (OCID).

Optional isIntentToPay

isIntentToPay: undefined | false | true

Payment intension.

Optional languageCode

languageCode: undefined | string

Language short code (en, de, hu, etc)

Optional organizationId

organizationId: undefined | string

GSI organization external identifier.

Optional paymentGateway

paymentGateway: model.PaymentGateway

Optional paymentOptions

paymentOptions: Array<PaymentOption>

Payment option list of a subscription.

Optional planType

planType: PlanType

Subscription plan type.

Optional shipToCustAcctRoleId

shipToCustAcctRoleId: undefined | string

Ship to customer account role.

Optional shipToCustAcctSiteId

shipToCustAcctSiteId: undefined | string

Ship to customer account site address id.

subscriptionPlanNumber

subscriptionPlanNumber: string

Subscription plan number.

Optional taxInfo

taxInfo: model.TaxInfo

Optional timePersonalToCorporateConv

timePersonalToCorporateConv: Date

Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE

Optional timePlanUpgrade

timePlanUpgrade: Date

Date of upgrade/conversion when planType changed from FREE_TIER to PAYG

Optional timeStart

timeStart: Date

Start date of the subscription.

Optional upgradeState

upgradeState: UpgradeState

Status of the upgrade.

Optional upgradeStateDetails

upgradeStateDetails: UpgradeStateDetails

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

Functions

getDeserializedJsonObj

getJsonObj