get entitlement term

GET https://api.suger.cloud/org/{orgId}/entitlement/{entitlementId}/entitlementTerm/{entitlementTermId}

Get the entitlement term by ID.

Parameters

Name	In	Type	Required	Description
`orgId`	path	string	yes	Organization ID
`entitlementId`	path	string	yes	Entitlement ID
`entitlementTermId`	path	string	yes	Entitlement Term ID

Responses

200 — OK

Content-Type: application/json · Schema: WorkloadEntitlementTerm

WorkloadEntitlementTerm fields:

Field	Type	Required	Description
`buyerID`	string	no
`commitAmount`	number	no
`creationTime`	string	no
`creditAmount`	number	no
`endTime`	string	no	nullable
`entitlementID`	string	no
`entitlementInfo`	EntitlementInfo	no
`externalEntitlementID`	string	no
`id`	string	no
`info`	EntitlementTermInfo	no
`lastUpdateTime`	string	no
`offerID`	string	no
`organizationID`	string	no
`partner`	Partner	no
`productID`	string	no
`reportedAmount`	number	no
`service`	PartnerService	no
`startTime`	string	no
`usedCommitAmount`	number	no
`usedCreditAmount`	number	no

EntitlementInfo fields:

Field	Type	Required	Description
`addons`	array<BillingAddonRecord>	no	The addons for the entitlement.
`alertDaysBeforeEnd`	integer	no	Alert days before the end of the entitlement
`alibabaEntitlements`	array<client.DescribeInstanceResponseBody>	no	Nullable. Alibaba Entitlements from Alibaba Marketplace.
`alibabaOrders`	array<client.DescribeOrderResponseBody>	no	Nullable. Alibaba Orders from Alibaba Marketplace.
`annualizedAmount`	number	no	AnnualizedAmount is the recurring contract value normalized to one year in Currency. Analytics converts this snapshot to USD before aggregation. A nil value means that the entitlement is usage-based, one-time, or cannot be annualized from authoritative contract terms. It is copied into entitlement-term snapshots so historical SaaS metrics do not depend on invoice frequency or payment timing.
`autoRenew`	boolean	no	Is this Entitlement Auto Renew enabled.
`awsAgreement`	AwsMarketplaceAgreementV2	no
`awsAgreementPdfURL`	string	no	AwsAgreementPdfURL is the S3 URL of the AWS Marketplace Agreement PDF.
`awsChannelPartner`	AwsChannelPartner	no
`awsEntitlements`	array<TypesEntitlement>	no	Nullable. AWS Entitlements from AWS Marketplace.
`awsLicenseArn`	string	no	AwsLicenseArn for AWS concurrent agreement support
`awsOfferSetId`	string	no	AwsOfferSetID is the AWS Marketplace OfferSet Id, available for agreements originated from an offer associated with an offerSet.
`azureAssetID`	string	no	AzureAssetID is the Azure CMA AssetId (order identifier) for this entitlement. For VM offers, this differs from Entitlement.ExternalID (which stores ReferenceId for Metered Usage matching). Revenue matching uses this field as a fallback when ExternalID lookup fails.
`azureSubscriptions`	array<AzureMarketplaceSubscription>	no	Nullable. Azure Subscriptions from Azure Marketplace.
`billableDimensions`	array<BillableDimension>	no	The dimensions for billable metric usage-based metering. It's for Suger(Stripe, Ayden) metering.
`billingCycle`	BillingCycle	no
`billingIntervalInMonths`	integer	no	The billing interval from the offer.
`buyerManagementURL`	string	no	The buyer's management URL in the cloud marketplace. For different cloud marketplaces, the buyer management URL maybe different.
`collectableAmount`	number	no	The amount that the seller can collect. It excludes the marketplace commision fee.
`commitAmount`	number	no	The amount that the buyer has committed to pay. It can be the sum of payment installments if applicable.
`commits`	array<CommitDimension>	no	The dimensions for flatrate commitment (recurring or one-time).
`currency`	string	no	The default Currency is USD.
`deliveryMethod`	OfferDeliveryMethod	no
`dimensions`	array<MeteringDimension>	no	The dimensions for usage-based metering. It's for usage metering in cloud marketplaces. The max size of dimensions is 50. The oversized dimensions won't be saved in the EntitlementInfo. But the dimensions can be accessed from the connected offer info or product info.
`dimensionsOversized`	boolean	no	Whether the upper metering dimensions are oversized (exceed the max size 50).
`disbursedAmount`	number	no	The amount that has been disbursed to the seller account.
`eulaType`	EulaType	no
`eulaUrl`	string	no
`fallbackFromOffer`	boolean	no	A flag indicates that the current entitlement info is from offer (private or default/public), not awsAgreementTerms from AWS Marketplace.
`gcpEntitlements`	array<GcpMarketplaceEntitlement>	no	Nullable. GCP Entitlements from GCP Marketplace.
`gcpPlans`	array<GcpMarketplaceProductPurchaseOptionSpec>	no	Only applicable for GCP Marketplace Entitlements.
`gracePeriodInDays`	integer	no	The grace period for the offer. It is same as the TrialConfig in DirectOfferInfo. But can be overridden at the entitlement level.
`grossAmount`	number	no	The gross amount that the buyer has committed to pay, including usage metered amount.
`invoicedAmount`	number	no	The amount that the buyer has got invoiced.
`isMeteringOverageCommit`	boolean	no	Whether the usage metering will be charged for the amount that exceeds the committed amount from the offer.
`netTermsInDays`	integer	no	The net terms for the offer. It is same as the TrialConfig in DirectOfferInfo. But can be overridden at the entitlement level.
`offerVisibility`	OfferVisibility	no
`oracleAcceptedOffer`	OracleMarketplaceOffer	no
`paymentInstallments`	array<PaymentInstallment>	no	For flexible payment schedules
`paymentSchedule`	PaymentScheduleType	no
`refundCancellationPolicy`	string	no
`sellerNotes`	string	no
`snowflakeOffer`	SnowflakeMarketplaceOffer	no
`spaUrl`	string	no	The URL with JWT as auth method for the entitlement SPA. It can be shared with the buyer to access the SPA without login.
`trialConfig`	TrialConfig	no
`vendorName`	string	no	VendorName is the name of the vendor/manufacturer of the product. It is populated from the product metadata (e.g., aws_marketplace_manufacturer_name attribute or AwsProduct.Description.Manufacturer).

EntitlementTermInfo fields:

Field	Type	Required	Description
`dimensionQuantityDecimalParts`	object	no	The decimal part of the dimension quantity, in format of <dimensionKey, decimalPart> It is used to save the decimal part of the dimension quantity for AWS Marketplace only. Because AWS Marketplace only accepts integer for dimension quantity. If the dimension quantity is a decimal number, we need to save the decimal part for future use.
`isCommitDivided`	boolean	no	Whether the commit is divided into multiple sub entitlement terms. If true, it has subEntitlementTermIds.
`parentEntitlementTermId`	string	no	The partner's entitlement term ID. It stands for the partner's entitlement term. Applicable to the sub entitlement term only.
`subEntitlementTermIds`	array<string>	no	All sub entitlement terms id of this entitlement term if it is commit divided.
`type`	EntitlementTermType	no

BillingAddonRecord fields:

Field	Type	Required
`amount`	number	no
`chargeOn`	string	no
`description`	string	no
`id`	string	no
`name`	string	no

client.DescribeInstanceResponseBody fields:

Field	Type	Required	Description
`ActiveAddress`	string	no
`AppJson`	string	no	example: {"frontEndUrl":"https://**.aliyundoc.com","password":"Sjtv","adminUrl":"https://*.aliyundoc.com","username":"aliyun*"}
`AutoRenewal`	string	no
`BeganOn`	integer	no	example: 1570634021000
`ComponentJson`	string	no	example: {"package_version":"yuncode000111"}
`Constraints`	string	no	example: {}
`CreatedOn`	integer	no	example: 1570634018000
`EndOn`	integer	no	example: 1602259200000
`ExtendJson`	string	no
`HostJson`	string	no	example: {"password":"*","ip":"118.31..41","innerIp":"118.31..41","region":"","username":"*","beianInfo":""}
`InstanceId`	integer	no	example: 1551111111
`IsTrial`	boolean	no	example: true
`LicenseCode`	string	no
`Modules`	client.DescribeInstanceResponseBodyModules	no
`OrderId`	integer	no	example: 204211111111111
`ProductCode`	string	no	example: cmgj00**11
`ProductName`	string	no
`ProductSkuCode`	string	no	example: cmgj00**11-prepay
`ProductType`	string	no	example: APP
`RelationalData`	client.DescribeInstanceResponseBodyRelationalData	no
`Status`	string	no	example: OPENED
`SupplierName`	string	no

client.DescribeOrderResponseBody fields:

Field	Type	Required	Description
`AccountQuantity`	integer	no	example: 0
`AliUid`	integer	no	example: 190311111111****
`Components`	object	no
`CouponPrice`	number	no	example: 0.0
`CreatedOn`	integer	no	example: 1531191564000
`InstanceIds`	client.DescribeOrderResponseBodyInstanceIds	no
`OrderId`	integer	no	example: 202211111111111
`OrderStatus`	string	no	example: NORMAL
`OrderType`	string	no	example: NEW
`OriginalPrice`	number	no	example: 10.0
`PaidOn`	integer	no	example: 1531191675000
`PayStatus`	string	no	example: PAID
`PaymentPrice`	number	no	example: 0.0
`PeriodType`	string	no	example: MONTH
`ProductCode`	string	no	example: cmgj02****
`ProductName`	string	no
`ProductSkuCode`	string	no	example: cmgj02****-prepay
`Quantity`	integer	no	example: 1
`RequestId`	string	no	example: 6EF60BEC-0242-43AF-BB20-270359FB54A7
`SupplierCompanyName`	string	no
`SupplierTelephones`	client.DescribeOrderResponseBodySupplierTelephones	no
`TotalPrice`	number	no	example: 0.0

AwsMarketplaceAgreementV2 fields:

Field	Type	Required	Description
`acceptanceTime`	string	no
`agreementId`	string	no	AWS Marketplace Agreement Id
`agreementType`	string	no
`buyerAccountId`	string	no	The AWS Account Id of the buyer in AWS Marketplace
`endTime`	string	no
`licenseArn`	string	no	AWS License Manager license ARN associated with this agreement (Concurrent Agreement support).
`offerId`	string	no	AWS Marketplace Offer Id
`offerSetId`	string	no	AWS Marketplace OfferSet Id, available for agreements originated from an offer associated with an offerSet.
`productId`	string	no	AWS Marketplace Product Id
`productType`	string	no
`sellerAccountId`	string	no	The AWS Account Id of the seller in AWS Marketplace
`startTime`	string	no
`status`	AwsMarketplaceAgreementStatus	no

AwsChannelPartner fields:

Field	Type	Required	Description
`id`	string	no	The AWS Account ID of the Channel Partner
`name`	string	no	The name of the Channel Partner

TypesEntitlement fields:

Field	Type	Required	Description
`customerAWSAccountId`	string	no	The CustomerAWSAccountId parameter specifies the AWS account ID of the buyer.
`customerIdentifier`	string	no	The customer identifier is a handle to each unique customer in an application. Customer identifiers are obtained through the ResolveCustomer operation in AWS Marketplace Metering Service.
`dimension`	string	no	The dimension for which the given entitlement applies. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.
`expirationDate`	string	no	The expiration date represents the minimum date through which this entitlement is expected to remain valid. For contractual products listed on AWS Marketplace, the expiration date is the date at which the customer will renew or cancel their contract. Customers who are opting to renew their contract will still have entitlements with an expiration date.
`licenseArn`	string	no	The LicenseArn is a unique identifier for a specific granted license. These are used for software purchased through AWS Marketplace.
`productCode`	string	no	The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the product listing is created.
`value`	types.EntitlementValue	no

AzureMarketplaceSubscription fields:

Field	Type	Required
`allowedCustomerOperations`	array<string>	no
`autoRenew`	boolean	no
`beneficiary`	AzureADIdentifier	no
`created`	string	no
`fulfillmentId`	string	no
`id`	string	no
`isFreeTrial`	boolean	no
`isTest`	boolean	no
`lastModified`	string	no
`name`	string	no
`offerId`	string	no
`planId`	string	no
`publisherId`	string	no
`purchaser`	AzureADIdentifier	no
`quantity`	integer	no
`saasSubscriptionStatus`	AzureMarketplaceSubscriptionStatus	no
`sandboxType`	string	no
`sessionId`	string	no
`sessionMode`	string	no
`storeFront`	string	no
`term`	AzureTerm	no

BillableDimension fields:

Field	Type	Required	Description
`billableMetricId`	string	no	The ID for the billable metric.
`category`	PriceModelCategory	no
`description`	string	no	Description of the dimension. This is used in the UI to display the dimension.
`discount`	BillingDiscount	no
`length`	integer	no	The term length for the commit amount. Applicable to Direct only.
`minimumCommit`	number	no	The minimum commit amount. Applicable to Direct only. Ignored if the value is 0 or less.
`minimumCommitProrata`	boolean	no	MinimumCommitProrata enables pro-rated minimum commit billing. Applicable to Direct only. If true, the minimum commit amount will be prorated based on the entitlement period. For example, if an entitlement is only active for 10 days of a monthly billing period, only 10/30 of the minimum commit amount will be charged.
`minimumCommitScope`	BillingMinimumCommitScope	no
`name`	string	no	Display name of the dimension. This is used in the UI to display the dimension.
`priceModelBasic`	PriceModelBasic	no
`priceModelBulk`	PriceModelBulk	no
`priceModelMatrix`	PriceModelMatrix	no
`priceModelPercentage`	PriceModelPercentage	no
`priceModelTiered`	PriceModelTiered	no
`priceModelTieredPercentage`	PriceModelTieredPercentage	no
`priceModelVolume`	PriceModelVolume	no
`timeUnit`	TimeUnit	no

CommitDimension fields:

Field	Type	Required	Description
`buyerQuantityConfigurable`	boolean	no	Whether the buyer must choose the quantity when accepting the offer.
`category`	string	no
`description`	string	no
`isUserCreated`	boolean	no	Whether this commit dimension is newly created by user, when creating AWS Marketplace Contract private offer.
`key`	string	no	API name of the dimension
`length`	integer	no	The term length for the commit amount, such as 6 months, or 1 year. The length is used together with timeUnit. If the length is zero, use the TermEndTime.
`maximumUsers`	integer	no	The maximum number of users for PER_USER commit
`minimumUsers`	integer	no	The minimum number of users for PER_USER commit
`name`	string	no	Display name of the dimension
`quantity`	integer	no	The quantity of this commit.
`rate`	number	no	The commit amount. For GCP, it is monthly commitment.
`term`	string	no	The term of the commit amount. It is used for front-end display only.
`termEndTime`	string	no	The end time of the commit term.
`timeUnit`	TimeUnit	no
`type`	CommitDimensionType	no
`types`	array<string>	no	These indicate whether the dimension covers metering, entitlement, or support for external metering

400 — Bad request error

Content-Type: application/json

500 — Internal server error

Content-Type: application/json

View as Markdown · Interactive API reference

Spotted something wrong or out of date on this page? Tell us and we'll correct it.