Subscription ============ A Subscription resource represents a subscription. Resource definition ------------------- .. literalinclude:: _static/Subscription.json :language: json +-------------------------------+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | Name | Type | Description | +===============================+=================================================+===================================================================================================================+ | Id | int | Identifier of the subscription | +-------------------------------+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | PublisherSubscriptionId | string | Internal identifier the publisher uses | +-------------------------------+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | Quantity | int | Number of license for the subscription | +-------------------------------+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | Name | string | A friendly name | +-------------------------------+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | Status | int | None = 0, Active = 1, Suspended = 2, Deleted = 4, CustomerCancellation = 8, Converted = 16 | +-------------------------------+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | OrderId | string | The publishers order identifier | +-------------------------------+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | Publisher | ObjectReference | The publisher the subscription is connected to | +-------------------------------+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | Organization | ObjectReference | The organization/reseller the subscription is connected to | +-------------------------------+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | CustomerTenant | CustomerTenantReference | The end customer company is connected to the subscription | +-------------------------------+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | Product | ProductReference | The license product for the subscription | +-------------------------------+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | CreationDate | DateTime | Date which the order was created | +-------------------------------+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | AvailableAddonsCount | int | Number of product types that can be added as child subscriptions | +-------------------------------+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | TermDuration | string | An ISO 8601 representation of the term's duration. Supported values P1M (1 month), P1Y (1 year) and P3Y (3 years).| +-------------------------------+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | CancellationAllowedUntilDate | DateTimeOffset? | Date by which the order can be canceled. | +-------------------------------+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | ScheduledNextTermInstructions | :doc:`/resources/ScheduledNextTermInstructions/`| Object to manage new commerce License-based renewal. | +-------------------------------+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | Subscriptions | :doc:`/resources/SubscriptionAddOn/` [ ] | List of child subscriptions | +-------------------------------+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | MaxEndCustomerQuantity | int? | Maximum threshold of licenses that can be ordered by end customer. (Applies only for T2 end customer companies) | +-------------------------------+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ Operations on subscription -------------------------- - :doc:`/scenarios/subscriptions-get`