Hide response attributes Show response attributes object
-
items array[object] | null
The items for this page.
Hide items attributes Show items attributes object
-
id string(uuid)
The id of the subscription.
-
orderId string(uuid)
The order id of the subscription.
-
offerId string(uuid)
The offer id of the subscription.
-
customerId string(uuid)
The customer id of the subscription.
-
providerInstanceId string(uuid)
The provider instance id of the subscription.
-
resellerId string(uuid) | null
The reseller id of the subscription.
-
subscriptionName string | null
The friendly name of the subscription.
-
offerName string | null
The name of the subscription.
-
offerType object
The offer type. Possible values: License, LicenseLegacy, SoftwareSubscription, PerpetualSoftware, AzurePlan, AzureReservation, AzureLegacy or AzureSavingsPlan.
Hide offerType attributes Show offerType attributes
-
name string | null
The name of the enumeration.
-
-
isAddonOffer boolean
The value indicating if the subscription offer is addon.
-
isTrialOffer boolean
The value indicating if the subscription offer is trial.
-
providerOfferId string | null
The provider offer identifier.
-
subscriptionStatus object
Hide subscriptionStatus attributes Show subscriptionStatus attributes
-
name string | null
The name of the enumeration.
-
-
startDate string(date-time)
The start date of the subscription.
-
endDate string(date-time)
The end date of the subscription.
-
cancellationAllowedUntil string(date-time) | null
The limit date to cancelled the subscription.
-
quantity integer(int32)
The quantity of the subscription.
-
listPrice object
The list price of the subscription. This value represents the cost price for the whole term of the subscription.
Hide listPrice attributes Show listPrice attributes
-
revenuePrice object
The revenue price of the subscription. This value represents the revenue price for the whole term of the subscription.
Hide revenuePrice attributes Show revenuePrice attributes
-
erpPrice object
The erp price of the subscription. This value represents the erp price for the whole term of the subscription.
Hide erpPrice attributes Show erpPrice attributes
-
customMargin object
This value object contains the price margin for this entity.
Hide customMargin attributes Show customMargin attributes
-
marginRule object Required
The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount
Hide marginRule attributes Show marginRule attributes
-
name string | null
The name of the enumeration.
-
-
value number(double) | null Required
The value applied to this price margin. Should not be below 0 or above 999.
-
-
billingFrequency object
The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
Hide billingFrequency attributes Show billingFrequency attributes
-
name string | null
The name of the enumeration.
-
-
billingType object
The billing type for the offer. Possible values: License, Usage or None
Hide billingType attributes Show billingType attributes
-
name string | null
The name of the enumeration.
-
-
termDuration object
The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
Hide termDuration attributes Show termDuration attributes
-
name string | null
The name of the enumeration.
-
-
segment object
The offer segment. Possible values: Commercial, Education, Government or NonProfit
Hide segment attributes Show segment attributes
-
name string | null
The name of the enumeration.
-
-
parentSubscriptionId string(uuid) | null
The parent subscription identifier.
-
providerSubscriptionId string | null
The provider's subscription identifier.
-
autoRenewal boolean
Whether the subscription auto renews.
-
providerData string | null
The subscription provider data.
-
internalId string | null
The internal identifier.
-
-
paginationParameters object
A model that is used to encapsulate the parameters needed to perform pagination queries.
Hide paginationParameters attributes Show paginationParameters attributes
-
pageNumber integer(int32)
Indicates the number of the current page.
-
pageSize integer(int32)
The number of items that should be returned at most per page.
-
-
totalPages integer(int32)
The total number of pages available for the specified parameters and page size.
-
totalCount integer(int32)
The total number of results available for the specified parameters. Note this is typically not equal to the Count of items in the Items property, will only be equal if all the items fit in the first page.
-
hasPreviousPage boolean
Indicates if there is a previous page.
-
hasNextPage boolean
Indicates if there is a next page.
-
continuationToken string | null
The token to continue to retrieve the paginated items.