Share via


Subscription Class

Definition

The subscription resource represents the life cycle of a subscription and includes properties that define the states throughout the subscription life cycle.

public sealed class Subscription : Microsoft.Store.PartnerCenter.Models.Contract
type Subscription = class
    inherit Contract
Public NotInheritable Class Subscription
Inherits Contract
Inheritance

Constructors

Subscription()

Initializes a new instance of the Subscription class.

Properties

Actions

Gets or sets the actions.

Attributes

Gets the attributes.

(Inherited from ResourceBase)
AutoRenewEnabled

Gets or sets a value indicating whether automatic renew is enabled or not.

BillingCycle

Gets or sets the billing cycle. Defines how often the partner is billed for this subscription.

BillingCycleEndDate

Gets or sets the billing cycle end date for term-based subscription, in date-time format.

BillingType

Gets or sets the billing type.

CancellationAllowedUntilDate

Gets or sets the last date that the partner can cancel their subscription for the given term, in UTC date-time format. For subscriptions that are not allowed to be cancelled, this value is null. For subscriptions that can be cancelled at any time, this value is term end date.

CommitmentEndDate

Gets or sets the commitment end date for this subscription. For subscriptions which are not auto renewable, this represents a date far away in the future.

ConsumptionType

Gets or sets the consumption type.

ContractType

Gets the type of contract.

CreationDate

Gets or sets the creation date.

EffectiveStartDate

Gets or sets the effective start date for this subscription. It is used to back date a migrated subscription or to align it with another.

EntitlementId

Gets or sets the entitlement identifier.

FriendlyName

Gets or sets the friendly name for the subscription.

HasPurchasableAddons

Gets or sets a value indicating whether the subscription has purchasable add-ons.

Id

Gets or sets the subscription identifier.

IsMicrosoftProduct

Gets or sets a value indicating whether gets or sets the value indicating that the availability is a Microsoft product.

IsTrial

Gets or sets a value indicating whether the subscription is a trial.

Links

Gets or sets the links.

MigratedFromSubscriptionId

Gets or sets the ID of the Traditional-Commerce subscription which the New-Commerce subscription was migrated from.

NextChargeInstructions

Gets or sets the next charge instructions for billing cycle changes during the next charge cycle (not applicable for legacy offers).

OfferId

Gets or sets the offer identifier.

OfferName

Gets or sets the offer name.

OrderId

Gets or sets the order identifier.

(Inherited from Contract)
ParentSubscriptionId

Gets or sets the parent subscription identifier.

PartnerId

Gets or sets the MPN identifier. This only applies to indirect partner scenarios.

ProductType

Gets or sets the product type for the subscription. Note: This property will only be populated for modern products in R2 until legacy is supported and other names are confirmed.

PromotionId

Gets or sets the promotion id.

PublisherName

Gets or sets the publisher name.

Quantity

Gets or sets the quantity. For example, in case of seat based billing, this property is set to seat count.

RefundableQuantity

Gets or sets the number of seats eligible for reduction at the time of the request.

RefundOptions

Gets or sets the refund options for this subscription if applicable.

RenewalTermDuration

Gets or sets the renewal term duration.

ScheduledNextTermInstructions

Gets or sets the next term instructions for scheduled changes during the next auto renewal (not applicable for legacy offers).

Status

Gets or sets the subscription status.

SuspensionReasons

Gets or sets the suspension reason.

TermDuration

Gets or sets the term duration.

UnitType

Gets or sets the units defining Quantity for the subscription.

Applies to