Subscription Class |
Subscription business class.
Inheritance HierarchyNamespace: Atomia.Billing.Core.Sdk.BusinessObjects
Assembly: Atomia.Billing.Core.Sdk (in Atomia.Billing.Core.Sdk.dll) Version: 18.10.7096.28998
SyntaxThe Subscription type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Subscription |
Initializes a new instance of the Subscription class.
|
Properties| Name | Description | |
|---|---|---|
 | AccountId |
Gets or sets the account id (reseller) which is the owner of this subscription.
|
| CompanyName |
Gets or sets the name of the company.
|
| CreatedByAccountId |
Gets or sets the created by account id.
|
| Currency |
Gets or sets the currency.
|
| CustomAttributes |
Gets or sets the custom attributes.
|
| CustomerId |
Gets or sets the customer id.
|
| DataObject |
Gets or sets the data object. When getting data object it creates a new object from the database.
|
| Deleted |
Gets or sets a value indicating whether this Subscription is deleted.
|
| Description |
Gets or sets the description.
|
| Discount |
Gets or sets the discount.
|
| ExpirationDate |
Gets or sets the expiration date.
|
| FirstName |
Gets or sets the first name.
|
| FriendlyId |
Gets or sets the friendly id.
|
| Id |
Gets or sets the id.
|
| InvoiceId |
Gets or sets the invoice id.
|
| IsDiscountTransferable |
Gets or sets a value indicating whether discount is transferable.
|
| IsProvisioningInProgress |
Gets or sets a value indicating whether provisioning is in progress.
|
| Item |
Gets or sets the item.
|
| ItemId |
Gets or sets the item id.
|
| ItemName |
Gets or sets the name of the item.
|
| LastName |
Gets or sets the last name.
|
| LastProvisioningAttemptTime |
Gets or sets the last provisioning attempt time.
|
| LegalNumber |
Gets or sets customer's legal number.
|
| NextRenewalDate |
Gets or sets the next renewal date.
|
| Notifications |
Gets or sets the subscription notifications.
|
| OldSubscription |
Gets or sets the old subscription for upgrades/downgrades to this one.
|
| Payment |
Gets Payment status.
This value is a string that can take the following values based on invoice state:
OK
FALSE
|
| ProvisioningAttempts |
Gets or sets the number of provisioning attempts.
|
| ProvisioningOrder |
Gets or sets the provisioning order.
|
| ProvisioningStatus |
Gets or sets the provisioning status.
This value is a string that can take the following values:
NONE
PREPARED (prepare provisioning is done).
PREPARE_ERROR (there was an error when prepare provisioning is tried).
PROVISIONED (provisioning is successfully finished).
PROVISION_ERROR (there was an error when provisioning is tried).
|
| ProvisioningStatusMessage |
Gets or sets the provisioning status error or warning message.
|
| Quantity |
Gets or sets the qunatity.
|
| Recurring |
Gets or sets a value indicating whether subscription is recurring.
|
| RenewalPeriod |
Gets or sets the renewal period.
|
| RenewalPeriodId |
Gets or sets the renewal period id.
|
| StartDate |
Gets or sets the start date.
|
| State |
Gets or sets the state.
|
| SubscriptionNotes |
Gets or sets the subscription notes.
|
| SubscriptionPrices |
Gets or sets the subscription prices.
|
| Type |
Gets or sets the type.
|
Methods| Name | Description | |
|---|---|---|
| CalculateNextRenewalDate(DateTime) |
Calculates the next renewal date from the starting date.
|
| CalculateNextRenewalDate(DateTime, RenewalPeriod) |
Calculates the next renewal date.
|
| CalculateProrateCoeficient |
Calculates the prorate coeficient.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UpdateDataObject |
Updates the data object by merging it's properties with the properties from the current business object.
|
FieldsTop
See Also