Skip to main content

get entitlement term

GET 
/org/:orgId/entitlement/:entitlementId/entitlementTerm/:entitlementTermId

Get the entitlement term by ID

Request​

Path Parameters

    orgId stringrequired

    Organization ID

    entitlementId stringrequired

    Entitlement ID

    entitlementTermId stringrequired

    Entitlement Term ID

Responses​

OK

Schema

    buyerID string
    commitAmount number
    creditAmount number
    endTime date-time

    nullable

    entitlementID string

    entitlementInfo

    object

    addons

    object[]

    The addons for the entitlement.

  • Array [

    • amount number
    chargeOn date-time
    description string
    id string
    name string

  • ]

    • alertDaysBeforeEnd integer

    Alert days before the end of the entitlement

    alibabaEntitlements

    object[]

    Nullable. Alibaba Entitlements from Alibaba Marketplace.

  • Array [

    • AppJson string
    AutoRenewal string
    BeganOn integer
    ComponentJson string
    Constraints string
    CreatedOn integer
    EndOn integer
    ExtendJson string
    HostJson string
    InstanceId integer
    IsTrial boolean

    Modules

    object

    Module

    object[]

  • Array [

    • Code string
    Id string
    Name string

    Properties

    object

    Property

    object[]

  • Array [

    • DisplayUnit string
    Key string
    Name string

    PropertyValues

    object

    PropertyValue

    object[]

  • Array [

    • DisplayName string
    Max string
    Min string
    Remark string
    Step string
    Type string
    Value string

  • ]

    • ShowType string

  • ]

  • ]

    • OrderId integer
    ProductCode string
    ProductName string
    ProductSkuCode string
    ProductType string

    RelationalData

    object

    ServiceStatus string
    Status string
    SupplierName string

  • ]

    • alibabaOrders

    object[]

    Nullable. Alibaba Orders from Alibaba Marketplace.

  • Array [

    • AccountQuantity integer
    AliUid integer

    Components

    object

    property name* any
    CouponPrice number
    CreatedOn integer

    InstanceIds

    object

    InstanceId string[]
    OrderId integer
    OrderStatus string
    OrderType string
    OriginalPrice number
    PaidOn integer
    PayStatus string
    PaymentPrice number
    PeriodType string
    ProductCode string
    ProductName string
    ProductSkuCode string
    Quantity integer
    RequestId string
    SupplierCompanyName string

    SupplierTelephones

    object

    Telephone string[]
    TotalPrice number

  • ]

    • autoRenew boolean

    Is this Entitlement Auto Renew enabled.

    awsAgreement

    object

    acceptanceTime date-time
    agreementId string

    AWS Marketplace Agreement Id

    agreementType string
    buyerAccountId string

    The AWS Account Id of the buyer in AWS Marketplace

    endTime date-time
    offerId string

    AWS Marketplace Offer Id

    productId string

    AWS Marketplace Product Id

    productType string
    sellerAccountId string

    The AWS Account Id of the seller in AWS Marketplace

    startTime date-time
    status AwsMarketplaceAgreementStatus (string)

    Possible values: [ACTIVE, ARCHIVED, CANCELLED, EXPIRED, RENEWED, REPLACED, ROLLED_BACK, SUPERSEDED, TERMINATED]

    awsChannelPartner

    object

    id string

    The AWS Account ID of the Channel Partner

    name string

    The name of the Channel Partner

    awsEntitlements

    object[]

    Nullable. AWS Entitlements from AWS Marketplace.

  • Array [

    • customerIdentifier string

    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

    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

    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.

    productCode string

    The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the product listing is created.

    value

    object

    booleanValue boolean

    The BooleanValue field will be populated with a boolean value when the entitlement is a boolean type. Otherwise, the field will not be set.

    doubleValue number

    The DoubleValue field will be populated with a double value when the entitlement is a double type. Otherwise, the field will not be set.

    integerValue integer

    The IntegerValue field will be populated with an integer value when the entitlement is an integer type. Otherwise, the field will not be set.

    stringValue string

    The StringValue field will be populated with a string value when the entitlement is a string type. Otherwise, the field will not be set.

  • ]

    • azureSubscriptions

    object[]

    Nullable. Azure Subscriptions from Azure Marketplace.

  • Array [

    • allowedCustomerOperations string[]

    Possible values: [Read, Update, Delete]

    autoRenew boolean

    beneficiary

    object

    billingAccountId string

    Azure Billing Account ID

    customerId string
    emailId string

    Email address

    firstName string
    lastName string
    licenseType string

    Azure License Type

    objectId string
    puid string

    ID of the user, used as External ID of suger IdentityBuyer.

    tenantId string
    created date-time
    fulfillmentId string
    id string
    isFreeTrial boolean
    isTest boolean
    lastModified string
    name string
    offerId string
    planId string
    publisherId string

    purchaser

    object

    billingAccountId string

    Azure Billing Account ID

    customerId string
    emailId string

    Email address

    firstName string
    lastName string
    licenseType string

    Azure License Type

    objectId string
    puid string

    ID of the user, used as External ID of suger IdentityBuyer.

    tenantId string
    quantity integer
    saasSubscriptionStatus AzureMarketplaceSubscriptionStatus (string)

    Possible values: [NotStarted, PendingFulfillmentStart, Subscribed, Suspended, Unsubscribed]

    sandboxType string

    Possible values: [None, Csp]

    sessionId string
    sessionMode string

    Possible values: [None, DryRun]

    storeFront string

    term

    object

    chargeDuration string
    endDate date-time
    startDate date-time
    termUnit string

  • ]

    • billableDimensions

    object[]

    The dimensions for billable metric usage-based metering. It's for Suger(Stripe, Ayden) metering.

  • Array [

    • billableMetricId string

    The ID for the billable metric.

    category PriceModelCategory (string)

    Possible values: [basic, tiered, bulk, volume, percentage, tiered-percentage, matrix]

    description string

    Description of the dimension. This is used in the UI to display the dimension.

    discount

    object

    discountType BillingDiscountType (string)

    Possible values: [PERCENTAGE, ABSOLUTE]

    value number
    length integer

    The term length for the commit amount. Applicable to Direct only.

    minimumCommit number

    The minimum commit amount. Applicable to Direct only. Ignored if the value is 0 or less.

    minimumCommitScope BillingMinimumCommitScope (string)

    Possible values: [``, DIMENSION, DIMENSION_GROUP_BY]

    name string

    Display name of the dimension. This is used in the UI to display the dimension.

    priceModelBasic

    object

    unitAmount number

    priceModelBulk

    object

    bulkAmount number

    A currency amount to rate usage by

    bulkSize integer

    An integer amount to represent package size. For example, 1000 here would divide usage by 1000 before multiplying by package_amount in rating

    priceModelMatrix

    object

    defaultUnitAmount number

    matrix

    object[]

    The matrix of the pricing model

  • Array [

    • properties

    object[]

  • Array [

    • name string
    value string

  • ]

    • unitAmount number

  • ]

    • priceModelPercentage

    object

    flatFee number
    percentageRate number

    Basis point take rate per event

    priceModelTiered

    object

    tiers

    object[]

  • Array [

    • firstUnit number

    Inclusive tier starting value

    flatFee number
    lastUnit number

    Exclusive tier ending value. If null, this is treated as the last tier

    unitAmount number

    Amount per unit

  • ]

    • priceModelTieredPercentage

    object

    tiers

    object[]

  • Array [

    • firstUnit number

    Inclusive tier starting value

    flatFee number
    lastUnit number

    Exclusive tier ending value. If null, this is treated as the last tier

    percentageRate number

  • ]

    • priceModelVolume

    object

    tiers

    object[]

  • Array [

    • flatFee number
    maximumUnits number

    Upper bound for this tier

    unitAmount number

    Amount per unit

  • ]

    • timeUnit TimeUnit (string)

    Possible values: [DAY, MONTH, YEAR]

  • ]

    • billingCycle BillingCycle (string)

    Possible values: [MONTH_FIRST_DAY, ENTITLEMENT_START_DATE]

    collectableAmount number

    The amount that the seller can collect. It excludes the marketplace commision fee.

    commitAmount number

    The amount that the buyer has committed to pay. It can be the sum of payment installments if applicable.

    commits

    object[]

    The dimensions for flatrate commitment (recurring or one-time).

  • Array [

    • category string
    description string
    isUserCreated boolean

    Whether this commit dimension is newly created by user, when creating AWS Marketplace Contract private offer.

    key string

    API name of the dimension

    length integer

    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

    Possible values: >= 1 and <= 1000000

    Default value: 1000000

    The maximum number of users for PER_USER commit

    minimumUsers integer

    Possible values: >= 1 and <= 1000000

    Default value: 1

    The minimum number of users for PER_USER commit

    name string

    Display name of the dimension

    quantity integer

    The quantity of this commit.

    rate number

    The commit amount. For GCP, it is monthly commitment.

    term string

    The term of the commit amount. It is used for front-end display only.

    termEndTime string

    The end time of the commit term.

    timeUnit TimeUnit (string)

    Possible values: [DAY, MONTH, YEAR]

    type CommitDimensionType (string)

    Possible values: [FLAT_RATE, PER_USER]

    types string[]

    These indicate whether the dimension covers metering, entitlement, or support for external metering

  • ]

    • currency string

    The default Currency is USD.

    dimensions

    object[]

    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.

  • Array [

    • category string
    description string

    includedBaseQuantities

    object[]

    how many quantities of this dimension are included in the commit.

  • Array [

    • isInfinite boolean
    quantity number
    recurringUnit string

    Possible values: [Monthly, Annual]

  • ]

    • key string
    name string

    Display name of the dimension. For GCP Marketplace, it is the metering metric ID without plan prefix.

    planId string

    The plan ID of the metering dimension. Applicable to GCP Marketplace only. No ISO duration suffix.

    planName string

    The name of the plan for the metering dimension. Applicable to GCP Marketplace only. It may contains the ISO duration suffix, such as P1Y.

    priceTiers

    object[]

    The price tiers of the metering dimension. Applicable to GCP Marketplace only.

  • Array [

    • fromAmount number

    such as 0

    price

    object

    currencyCode string

    such as "USD"

    nanos integer

    for the decimal part, such as 30000000 = $0.03

    units string

    for the integer part, such as "500000" = $50K

    startingUsageAmount string

    such as "0"

  • ]

    • rate number

    The unit price of this usage metering dimension.

    skuId string

    The SKU ID of the metering dimension. Applicable to GCP Marketplace only.

    types string[]

    usageCount

    object

    creditCount number

    The count of this dimension usage records that are handled as credit.

    includedCount number

    The count of this dimension usage records that are handled as included in IncludedBaseQuantity

    reportedCount number

    The count of this dimension usage records that are reported to cloud vendors.

    valueType ValueType (string)

    Possible values: [``, VALUE_TYPE_UNSPECIFIED, BOOL, INT64, DOUBLE, STRING, DISTRIBUTION, MONEY]

  • ]

    • dimensionsOversized boolean

    Whether the upper metering dimensions are oversized (exceed the max size 50).

    disbursedAmount number

    The amount that has been disbursed to the seller account.

    eulaType EulaType (string)

    Possible values: [``, SCMP, ECMP, RCMP, CUSTOM, ISV, CURRENT]

    eulaUrl string

    gcpEntitlements

    object[]

    Nullable. GCP Entitlements from GCP Marketplace.

  • Array [

    • account string

    The resource name of the account that this entitlement is based on, if any, in format ""providers/{provider_id}/accounts/{account_id}"

    consumers

    object[]

    The resources using this entitlement, if applicable.

  • Array [

    • project string

    The project name with format projects/.

  • ]

    • createTime date-time
    id string

    Entitlement Id generated by GCP Marketplace. For Marketplace pub/sub event.

    inputProperties integer[]

    The custom properties that were collected from the user to create this entitlement.

    messageToUser string

    Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes.

    name string

    The resource name of the entitlement. Entitlement names have the form of providers/{provider_id}/entitlements/{entitlement_id}.

    newOfferDuration string

    in ISO 8601 duration format, such as "P2Y3M". For Marketplace pub/sub event.

    newOfferEndTime string

    Output only. The end time of the new offer. Field is empty if the pending plan change is not moving to an offer. If the offer was created with a term instead of a specified end date, this field is empty.

    newOfferStartTime string

    Output only. The start time of the new offer. Field is empty if the pending plan change is not moving to an offer.

    newPendingOffer string

    The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public.

    newPendingOfferDuration string

    The offer duration of the new offer in ISO 8601 duration format. Field is empty if the pending plan change is not moving to an offer since the entitlement is not pending, only the plan change is pending.

    newPendingPlan string

    The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change.

    newPlan string

    When the buyer changes plan, For Marketplace pub/sub event.

    offer string

    The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public.

    offerDuration string

    The offer duration of the current offer in ISO 8601 duration format. Field is empty if entitlement was not made using an offer, such as "P1Y", "P2M"

    offerEffectiveTime date-time

    When the offer is effective.

    offerEndTime date-time

    Output only. End time for the Offer association corresponding to this entitlement. The field is only populated if the entitlement is currently associated with an Offer.

    plan string

    The identifier of the plan that was procured. Required if the product has plans.

    product string

    The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. For Private offer, "projects/project-id/services/product-id.endpoints.partner-id.cloud.goog/privateOffers/private-offer-id"

    productExternalName string

    The identifier of the product that was procured.

    provider string

    The ID of the service provider under Cloud Commerce platform that this entitlement was created against.

    quoteExternalName string

    The identifier of the quote that was used to procure, such as the private offer Id. Empty if the order is not purchased using a quote.

    state GcpMarketplaceEntitlementState (string)

    Possible values: [ENTITLEMENT_STATE_UNSPECIFIED, ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_CANCELLED, ENTITLEMENT_PENDING_PLAN_CHANGE, ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, ENTITLEMENT_SUSPENDED]

    subscriptionEndTime date-time

    The End time for the subscription corresponding to this entitlement.

    updateTime date-time

    The last update timestamp. It is the endTime for the cancelled entitlement.

    usageReportingId string

    The consumerId to use when reporting usage through the Service Control API. See the consumerId field at Reporting Metrics (https://cloud.google.com/service-control/reporting-metrics) for more details. This field is present only if the product has usage-based billing configured.

  • ]

    • gcpPlans

    object[]

    Only applicable for GCP Marketplace Entitlements.

  • Array [

    • featureValues

    object[]

  • Array [

    • featureDescription string

    such as "CPU per VM"

    featureName string

    such as "cpu"

    featureTitle string

    such as "CPU"

    featureValue string

    such as "2 CPU per VM"

  • ]

    • name string

    The plan ID, such as "starter", without the duration suffix, such as "P1Y".

    priceInfo

    object

    description string
    priceModel GcpMarketplacePriceModel (string)

    Possible values: [FREE, SUBSCRIPTION, USAGE, SUBSCRIPTION_PLUS_USAGE]

    subscriptionPlans

    object[]

    Subscription Plan (Flat Commitment)

  • Array [

    • period string

    such as "ONE_YEAR", "TWO_YEAR", "THREE_YEAR"

    price

    object

    currencyCode string

    such as "USD"

    nanos integer

    for the decimal part, such as 30000000 = $0.03

    units string

    for the integer part, such as "500000" = $50K

  • ]

    • usageFees

    object[]

    Usage Metering Dimension/Metric if available

  • Array [

    • displayQuantity integer

    such as 1

    metricId string

    such as "Starter_storage"

    priceTiers

    object[]

  • Array [

    • fromAmount number

    such as 0

    price

    object

    currencyCode string

    such as "USD"

    nanos integer

    for the decimal part, such as 30000000 = $0.03

    units string

    for the integer part, such as "500000" = $50K

    startingUsageAmount string

    such as "0"

  • ]

  • ]

    • purchaseMode string

    Possible values: [PURCHASE_MODE_PRIVATE, PURCHASE_MODE_PUBLIC]

    title string

    such as "Starter"

  • ]

    • gracePeriodInDays integer

    The grace period for the offer. It is same as the TrialConfig in DirectOfferInfo. But can be overridden at the entitlement level.

    grossAmount number

    The gross amount that the buyer has committed to pay, including usage metered amount.

    invoicedAmount number

    The amount that the buyer has got invoiced.

    netTermsInDays integer

    The net terms for the offer. It is same as the TrialConfig in DirectOfferInfo. But can be overridden at the entitlement level.

    paymentInstallments

    object[]

    For flexible payment schedules

  • Array [

    • amount number

    The amount the buyer has paid for this installment. If there is a discount off the original price, the amount is the discounted price.

    chargeOn date-time

    When the buyer will be charged for this installment. If it is null, the buyer will be charged on the effective date of the entitlement.

    chargeOnStr string

    The charge on date in string format. It is used for front-end display only.

    credit number

    Used in GCP Marketplace private offer as one-time credit. Default as zero if there is no credit.

    discountPercentage number

    The discount percentage off the original price. For GCP Marketplace, it can be discount off the commitment amount or discount off the usage price. The value is between 0 to 100. For example, 20 means 20% off. Default as zero if there is no discount.

    originalAmount number

    The original amount before discount if there is a discount off the original price. nil if there is no discount.

  • ]

    • paymentSchedule PaymentScheduleType (string)

    Possible values: [``, PREPAY, POSTPAY]

    refundCancellationPolicy string
    sellerNotes string
    spaUrl string

    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

    object

    trialPeriod integer
    trialPeriodUnit TimeUnit (string)

    Possible values: [DAY, MONTH, YEAR]

    externalEntitlementID string
    id string

    info

    object

    dimensionQuantityDecimalParts

    object

    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.

    property name* number
    isCommitDivided boolean

    Whether the commit is divided into multiple sub entitlement terms. If true, it has subEntitlementTermIds.

    parentEntitlementTermId string

    The partner's entitlement term ID. It stands for the partner's entitlement term. Applicable to the sub entitlement term only.

    subEntitlementTermIds string[]

    All sub entitlement terms id of this entitlement term if it is commit divided.

    type EntitlementTermType (string)

    Possible values: [``, AutoRenew, ManualRenew, PlanChange, QuantityChange, Signup, DivideCommit]

    offerID string
    organizationID string
    partner Partner (string)

    Possible values: [``, ADYEN, ALIBABA, AWS, AWS_CHINA, AZURE, GCP, GOOGLE, HUBSPOT, LAGO, MARKETO, METRONOME, MICROSOFT, ORACLE, ORB, REDHAT, SALESFORCE, SLACK, STRIPE, ZOHO]

    productID string
    reportedAmount number
    service PartnerService (string)

    Possible values: [DEFAULT, MARKETPLACE, ACE, COSELL, CRM, CPQ, CHATBOT, BILLING, BIGQUERY, DRIVE, EMAIL, STORAGE, PAYMENT, TEAMS]

    startTime date-time
    usedCommitAmount number
    usedCreditAmount number
Loading...