get entitlement
GET/org/:orgId/entitlement/:entitlementId
Get the entitlement by ID.
Request
Path Parameters
Organization ID
Entitlement ID
Responses
- 200
- 400
- 404
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
Array [
Array [
Array [
]
]
]
]
Array [
]
Array [
]
Array [
]
Array [
Array [
Array [
]
]
Array [
]
Array [
]
Array [
]
]
Array [
]
Array [
Array [
]
Array [
]
]
Array [
Array [
]
]
Array [
Array [
]
Array [
]
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
nullable
info
object
addons
object[]
The addons for the entitlement.
Alert days before the end of the entitlement
alibabaEntitlements
object[]
Nullable. Alibaba Entitlements from Alibaba Marketplace.
Modules
object
Module
object[]
Properties
object
Property
object[]
PropertyValues
object
PropertyValue
object[]
RelationalData
object
alibabaOrders
object[]
Nullable. Alibaba Orders from Alibaba Marketplace.
Components
object
InstanceIds
object
SupplierTelephones
object
Is this Entitlement Auto Renew enabled.
awsAgreement
object
AWS Marketplace Agreement Id
The AWS Account Id of the buyer in AWS Marketplace
AWS Marketplace Offer Id
AWS Marketplace Product Id
The AWS Account Id of the seller in AWS Marketplace
Possible values: [ACTIVE, ARCHIVED, CANCELLED, EXPIRED, RENEWED, REPLACED, ROLLED_BACK, SUPERSEDED, TERMINATED]
awsChannelPartner
object
The AWS Account ID of the Channel Partner
The name of the Channel Partner
awsEntitlements
object[]
Nullable. AWS Entitlements from AWS Marketplace.
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.
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.
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.
The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the product listing is created.
value
object
The BooleanValue field will be populated with a boolean value when the entitlement is a boolean type. Otherwise, the field will not be set.
The DoubleValue field will be populated with a double value when the entitlement is a double type. Otherwise, the field will not be set.
The IntegerValue field will be populated with an integer value when the entitlement is an integer type. Otherwise, the field will not be set.
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.
Possible values: [Read, Update, Delete]
beneficiary
object
Azure Billing Account ID
Email address
Azure License Type
ID of the user, used as External ID of suger IdentityBuyer.
purchaser
object
Azure Billing Account ID
Email address
Azure License Type
ID of the user, used as External ID of suger IdentityBuyer.
Possible values: [NotStarted, PendingFulfillmentStart, Subscribed, Suspended, Unsubscribed]
Possible values: [None, Csp]
Possible values: [None, DryRun]
term
object
billableDimensions
object[]
The dimensions for billable metric usage-based metering. It's for Suger(Stripe, Ayden) metering.
The ID for the billable metric.
Possible values: [basic, tiered, bulk, volume, percentage, tiered-percentage, matrix]
Description of the dimension. This is used in the UI to display the dimension.
discount
object
Possible values: [PERCENTAGE, ABSOLUTE]
The term length for the commit amount. Applicable to Direct only.
The minimum commit amount. Applicable to Direct only. Ignored if the value is 0 or less.
If the minimum commit is appled with pro-rata. Applicable to Direct only. If true, the minimum commit amount will be prorated based on the usage period (starting time and ending time).
Possible values: [``, DIMENSION, DIMENSION_GROUP_BY]
Display name of the dimension. This is used in the UI to display the dimension.
priceModelBasic
object
priceModelBulk
object
A currency amount to rate usage by
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
matrix
object[]
The matrix of the pricing model
properties
object[]
priceModelPercentage
object
Basis point take rate per event
priceModelTiered
object
tiers
object[]
Inclusive tier starting value
Exclusive tier ending value. If null, this is treated as the last tier
Amount per unit
priceModelTieredPercentage
object
tiers
object[]
Inclusive tier starting value
Exclusive tier ending value. If null, this is treated as the last tier
priceModelVolume
object
tiers
object[]
Upper bound for this tier
Amount per unit
Possible values: [DAY, MONTH, YEAR]
Possible values: [MONTH_FIRST_DAY, ENTITLEMENT_START_DATE]
The amount that the seller can collect. It excludes the marketplace commision fee.
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).
Whether this commit dimension is newly created by user, when creating AWS Marketplace Contract private offer.
API name of the dimension
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.
Possible values: >= 1 and <= 1000000
Default value: 1000000
The maximum number of users for PER_USER commit
Possible values: >= 1 and <= 1000000
Default value: 1
The minimum number of users for PER_USER commit
Display name of the dimension
The quantity of this commit.
The commit amount. For GCP, it is monthly commitment.
The term of the commit amount. It is used for front-end display only.
The end time of the commit term.
Possible values: [DAY, MONTH, YEAR]
Possible values: [FLAT_RATE, PER_USER]
These indicate whether the dimension covers metering, entitlement, or support for external metering
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.
includedBaseQuantities
object[]
how many quantities of this dimension are included in the commit.
Possible values: [Monthly, Annual]
Display name of the dimension. For GCP Marketplace, it is the metering metric ID without plan prefix.
The plan ID of the metering dimension. Applicable to GCP Marketplace only. No ISO duration suffix.
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.
such as 0
price
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
such as "0"
The unit price of this usage metering dimension.
The SKU ID of the metering dimension. Applicable to GCP Marketplace only.
usageCount
object
The count of this dimension usage records that are handled as credit.
The count of this dimension usage records that are handled as included in IncludedBaseQuantity
The count of this dimension usage records that are reported to cloud vendors.
Possible values: [``, VALUE_TYPE_UNSPECIFIED, BOOL, INT64, DOUBLE, STRING, DISTRIBUTION, MONEY]
Whether the upper metering dimensions are oversized (exceed the max size 50).
The amount that has been disbursed to the seller account.
Possible values: [``, SCMP, ECMP, RCMP, CUSTOM, ISV, CURRENT]
gcpEntitlements
object[]
Nullable. GCP Entitlements from GCP Marketplace.
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.
The project name with format projects/.
Entitlement Id generated by GCP Marketplace. For Marketplace pub/sub event.
The custom properties that were collected from the user to create this entitlement.
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.
The resource name of the entitlement. Entitlement names have the form of
providers/{provider_id}/entitlements/{entitlement_id}.
in ISO 8601 duration format, such as "P2Y3M". For Marketplace pub/sub event.
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.
Output only. The start time of the new offer. Field is empty if the pending plan change is not moving to an offer.
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.
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.
The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change.
When the buyer changes plan, For Marketplace pub/sub event.
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.
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"
When the offer is effective.
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.
The identifier of the plan that was procured. Required if the product has plans.
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"
The identifier of the product that was procured.
The ID of the service provider under Cloud Commerce platform that this entitlement was created against.
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.
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]
The End time for the subscription corresponding to this entitlement.
The last update timestamp. It is the endTime for the cancelled entitlement.
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.
featureValues
object[]
such as "CPU per VM"
such as "cpu"
such as "CPU"
such as "2 CPU per VM"
The plan ID, such as "starter", without the duration suffix, such as "P1Y".
priceInfo
object
Possible values: [FREE, SUBSCRIPTION, USAGE, SUBSCRIPTION_PLUS_USAGE]
subscriptionPlans
object[]
Subscription Plan (Flat Commitment)
such as "ONE_YEAR", "TWO_YEAR", "THREE_YEAR"
price
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
usageFees
object[]
Usage Metering Dimension/Metric if available
such as 1
such as "Starter_storage"
priceTiers
object[]
such as 0
price
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
such as "0"
Possible values: [PURCHASE_MODE_PRIVATE, PURCHASE_MODE_PUBLIC]
such as "Starter"
The grace period for the offer. It is same as the TrialConfig in DirectOfferInfo. But can be overridden at the entitlement level.
The gross amount that the buyer has committed to pay, including usage metered amount.
The amount that the buyer has got invoiced.
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
The amount the buyer has paid for this installment. If there is a discount off the original price, the amount is the discounted price.
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.
The charge on date in string format. It is used for front-end display only.
Used in GCP Marketplace private offer as one-time credit. Default as zero if there is no credit.
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.
The original amount before discount if there is a discount off the original price. nil if there is no discount.
Possible values: [``, PREPAY, POSTPAY]
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
Possible values: [DAY, MONTH, YEAR]
metaInfo
object
The linked ACE ApnCrmUniqueIdentifier of the private offer if available.
awsSaasProductDimensions
object[]
The AWS SaaS product dimensions. Applicable for AWS SaaS products only. This is used to save price info when creating AWS SaaS product.
The term length for the commit amount, such as 6 months, or 1 year. The length is used together with timeUnit. Length and TimeUnit are only used for commit dimension.
Below three fields are only used for pass data when create or update product's public offer pricing. Rate is only used for update public offer, becasue rate will be set as 0.01 when create new product.
Possible values: [DAY, MONTH, YEAR]
Applicable for AWS Marketplace only, when the IsAgreementBasedOffer is true.
The Suger buyer IDs of the private offer if available.
contacts
object[]
The contacts of the offer to notify if any updates.
The Suger CPPO_IN offer ID.
The Suger CPPO offer ID.
The Suger CPPO_OUT offer ID.
customMetaInfo
object
The custom meta info of the offer can be updated by seller via API or console.
If enabled, Suger will test metering the usage for this entitlement hourly.
entitlementCancellationSchedule
object
The cancellation date of the entitlement. It is required when the type is SpecificDate.
When this cancellation schedule is created.
Possible values: <= 500 characters
The cancellation note. Max 500 characters.
Possible values: [EndOfTerm, Immediate, SpecificDate]
Cancellation type
The error messages when the offer is invalid or offer related tasks failed. Populated by Suger service.
Hubsport deal ID of the private offer if available.
The Internal note of the private offer. It is only visible to the seller/ISV, not visible to the buyer. Up to 1000 characters.
Applicable for AWS Marketplace only, If this offer is agreement based offer.
Whether the gross revenue is fully synced for the entitlement.
Applicable for AWS Marketplace only. If this offer is renewal offer of existing agreement. The existing agreement can be within or outside AWS Marketplace. AWS may audit and verify your offer is a renewal. If AWS is unable to verify your offer, then AWS may revoke the offer and entitlements from your customer.
If this offer is a GCP replacement offer. Applicable for GCP Marketplace replacement offer only.
lastModifiedBy
object
The email of the creator.
The ID of the creator.
Possible values: [``, API_CLIENT, AUDITING_EVENT, AUTO_SHARE_TASK, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, HEADLESS_ENTITLEMENTS, HUBSPOT_USER, INTEGRATION, INVOICE, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SUPPORT_TICKET, UNPURCHASED_OFFERS, USAGE_RECORD_GROUP, USAGE_RECORD_REPORT, USER, WORKFLOW]
The Entity type of the creator, either USER or API_CLIENT.
The name of the creator.
notifications
object[]
The notifications of the offer if any updates. In most cases, it is to notify contacts/buyers when the offer is pending acceptance.
Possible values: [``, ABNORMAL_ALERT, ACCEPT, ADD, APPROVE, CANCEL, CLOSE, CREATE, DELETE, DISBURSE, END_SOON, EXPIRE, EXPIRE_SOON, MERGE, METER, NEW_CLIENT_SIGNUP, NOTIFY, NOTIFY_CONTACTS, OPEN_EMAIL, PENDING_CANCEL, PENDING_ACCEPTANCE, REINSTATE, REJECT, REOPEN, CHARGE, REFUND, ISSUE, ROTATE_SECRET, SUSPEND, TEST, UPDATE, ACE_ENGAGEMENT_SCORE_UPDATE, ACE_SALES_REP_UPDATE, ACE_CUSTOMER_EMAIL_UPDATE, SUBMIT_APPROVAL_REQUEST, REVIEW_APPROVAL_REQUEST, COMPLETE]
Cc contactIds that will receive this notification
Possible values: [EMAIL, SLACK, SMS, SNS, SALESFORCE, WEBHOOK, SUGER_SUPPORT, MICROSOFT_TEAMS]
The list of channels this event will be sent to, e.g., ["SLACK", "EMAIL"]
Contact emails that will receive this notification
ContactIds that will receive this notification
createdBy
object
The email of the creator.
The ID of the creator.
Possible values: [``, API_CLIENT, AUDITING_EVENT, AUTO_SHARE_TASK, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, HEADLESS_ENTITLEMENTS, HUBSPOT_USER, INTEGRATION, INVOICE, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SUPPORT_TICKET, UNPURCHASED_OFFERS, USAGE_RECORD_GROUP, USAGE_RECORD_REPORT, USER, WORKFLOW]
The Entity type of the creator, either USER or API_CLIENT.
The name of the creator.
customFields
object
Custom fields of the notification event.
Custom fields of the notification event.
The name of the entity.
Possible values: [``, API_CLIENT, AUDITING_EVENT, AUTO_SHARE_TASK, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, HEADLESS_ENTITLEMENTS, HUBSPOT_USER, INTEGRATION, INVOICE, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SUPPORT_TICKET, UNPURCHASED_OFFERS, USAGE_RECORD_GROUP, USAGE_RECORD_REPORT, USER, WORKFLOW]
notification event id.
Possible values: [``, SCHEDULED, PENDING, DONE, FAILED]
Additional info of the notification event.
If this notification event is an action item.
timestamp of the event when it is updated.
The message of the notification event such as email body, action item description.
suger organization id.
Possible values: [``, ADYEN, ALIBABA, AWS, AWS_CHINA, AZURE, GCP, GOOGLE, HUBSPOT, INTUIT, LAGO, MARKETO, METRONOME, MICROSOFT, ORACLE, ORB, REDHAT, SALESFORCE, SLACK, SNOWFLAKE, STRIPE, ZOHO]
Possible values: [``, LOW, MEDIUM, HIGH, CRITICAL]
If this notification event is an auditing event and need to store in DB.
timestamp of the event when it is scheduled or created.
The title of the notification event such as email subject, action item title.
trackEvents
object[]
The track events of the notification event.
Possible values: [OPEN_EMAIL]
The ID of the contact who triggered the track event if applicable.
timestamp of the track event happened.
The date when the offer is accepted by the buyer. Only available when the private offer has been accepted.
Possible values: [``, External, AwsMarketplace]
The end time of the replaced offer. Applicable for GCP Marketplace replacement offer only.
The resource name of the GCP Marketplace offer that this offer is replacing. In format of "projects/{gcpProjectNumber}/services/{productServiceName}/privateOffers/{privateOfferId}" Applicable for GCP Marketplace replacement offer only.
The Salesforce entitlement URL
The Salesforce opportunity ID of the private offer if available.
The test usage metering end time. It is used for test usage metering only. Required if EnableTestUsageMetering is true.
The message to notify when the offer is updated.
Possible values: [``, ADYEN, ALIBABA, AWS, AWS_CHINA, AZURE, GCP, GOOGLE, HUBSPOT, INTUIT, LAGO, MARKETO, METRONOME, MICROSOFT, ORACLE, ORB, REDHAT, SALESFORCE, SLACK, SNOWFLAKE, STRIPE, ZOHO]
Possible values: [DEFAULT, ACE, BIGQUERY, BILLING, CHATBOT, COSELL, CRM, CPQ, DATABASE, DRIVE, EMAIL, MARKETPLACE, NETSUITE, PAYMENT, QUICKBOOKS, STORAGE, TEAMS]
Possible values: [``, ACTIVE, CANCELLED, DELETED, PENDING_CANCEL, PENDING_START, SUSPENDED]
{
"buyerID": "string",
"creationTime": "2024-07-29T15:51:28.071Z",
"endTime": "2024-07-29T15:51:28.071Z",
"entitlementTermID": "string",
"externalBuyerID": "string",
"externalID": "string",
"externalProductID": "string",
"id": "string",
"info": {
"addons": [
{
"amount": 0,
"chargeOn": "2024-07-29T15:51:28.071Z",
"description": "string",
"id": "string",
"name": "string"
}
],
"alertDaysBeforeEnd": 0,
"alibabaEntitlements": [
{
"AppJson": "string",
"AutoRenewal": "string",
"BeganOn": 0,
"ComponentJson": "string",
"Constraints": "string",
"CreatedOn": 0,
"EndOn": 0,
"ExtendJson": "string",
"HostJson": "string",
"InstanceId": 0,
"IsTrial": true,
"Modules": {
"Module": [
{
"Code": "string",
"Id": "string",
"Name": "string",
"Properties": {
"Property": [
{
"DisplayUnit": "string",
"Key": "string",
"Name": "string",
"PropertyValues": {
"PropertyValue": [
{
"DisplayName": "string",
"Max": "string",
"Min": "string",
"Remark": "string",
"Step": "string",
"Type": "string",
"Value": "string"
}
]
},
"ShowType": "string"
}
]
}
}
]
},
"OrderId": 0,
"ProductCode": "string",
"ProductName": "string",
"ProductSkuCode": "string",
"ProductType": "string",
"RelationalData": {
"ServiceStatus": "string"
},
"Status": "string",
"SupplierName": "string"
}
],
"alibabaOrders": [
{
"AccountQuantity": 0,
"AliUid": 0,
"Components": {},
"CouponPrice": 0,
"CreatedOn": 0,
"InstanceIds": {
"InstanceId": [
"string"
]
},
"OrderId": 0,
"OrderStatus": "string",
"OrderType": "string",
"OriginalPrice": 0,
"PaidOn": 0,
"PayStatus": "string",
"PaymentPrice": 0,
"PeriodType": "string",
"ProductCode": "string",
"ProductName": "string",
"ProductSkuCode": "string",
"Quantity": 0,
"RequestId": "string",
"SupplierCompanyName": "string",
"SupplierTelephones": {
"Telephone": [
"string"
]
},
"TotalPrice": 0
}
],
"autoRenew": true,
"awsAgreement": {
"acceptanceTime": "2024-07-29T15:51:28.071Z",
"agreementId": "string",
"agreementType": "string",
"buyerAccountId": "string",
"endTime": "2024-07-29T15:51:28.071Z",
"offerId": "string",
"productId": "string",
"productType": "string",
"sellerAccountId": "string",
"startTime": "2024-07-29T15:51:28.071Z",
"status": "ACTIVE"
},
"awsChannelPartner": {
"id": "string",
"name": "string"
},
"awsEntitlements": [
{
"customerIdentifier": "string",
"dimension": "string",
"expirationDate": "string",
"productCode": "string",
"value": {
"booleanValue": true,
"doubleValue": 0,
"integerValue": 0,
"stringValue": "string"
}
}
],
"azureSubscriptions": [
{
"allowedCustomerOperations": [
"Read"
],
"autoRenew": true,
"beneficiary": {
"billingAccountId": "string",
"customerId": "string",
"emailId": "string",
"firstName": "string",
"lastName": "string",
"licenseType": "string",
"objectId": "string",
"puid": "string",
"tenantId": "string"
},
"created": "2024-07-29T15:51:28.071Z",
"fulfillmentId": "string",
"id": "string",
"isFreeTrial": true,
"isTest": true,
"lastModified": "string",
"name": "string",
"offerId": "string",
"planId": "string",
"publisherId": "string",
"purchaser": {
"billingAccountId": "string",
"customerId": "string",
"emailId": "string",
"firstName": "string",
"lastName": "string",
"licenseType": "string",
"objectId": "string",
"puid": "string",
"tenantId": "string"
},
"quantity": 0,
"saasSubscriptionStatus": "NotStarted",
"sandboxType": "None",
"sessionId": "string",
"sessionMode": "None",
"storeFront": "string",
"term": {
"chargeDuration": "string",
"endDate": "2024-07-29T15:51:28.071Z",
"startDate": "2024-07-29T15:51:28.071Z",
"termUnit": "string"
}
}
],
"billableDimensions": [
{
"billableMetricId": "string",
"category": "basic",
"description": "string",
"discount": {
"discountType": "PERCENTAGE",
"value": 0
},
"length": 0,
"minimumCommit": 0,
"minimumCommitProrata": true,
"minimumCommitScope": "",
"name": "string",
"priceModelBasic": {
"unitAmount": 0
},
"priceModelBulk": {
"bulkAmount": 0,
"bulkSize": 0
},
"priceModelMatrix": {
"defaultUnitAmount": 0,
"matrix": [
{
"properties": [
{
"name": "string",
"value": "string"
}
],
"unitAmount": 0
}
]
},
"priceModelPercentage": {
"flatFee": 0,
"percentageRate": 0
},
"priceModelTiered": {
"tiers": [
{
"firstUnit": 0,
"flatFee": 0,
"lastUnit": 0,
"unitAmount": 0
}
]
},
"priceModelTieredPercentage": {
"tiers": [
{
"firstUnit": 0,
"flatFee": 0,
"lastUnit": 0,
"percentageRate": 0
}
]
},
"priceModelVolume": {
"tiers": [
{
"flatFee": 0,
"maximumUnits": 0,
"unitAmount": 0
}
]
},
"timeUnit": "DAY"
}
],
"billingCycle": "MONTH_FIRST_DAY",
"collectableAmount": 0,
"commitAmount": 0,
"commits": [
{
"category": "string",
"description": "string",
"isUserCreated": true,
"key": "string",
"length": 0,
"maximumUsers": 1000000,
"minimumUsers": 1,
"name": "string",
"quantity": 0,
"rate": 0,
"term": "string",
"termEndTime": "string",
"timeUnit": "DAY",
"type": "FLAT_RATE",
"types": [
"string"
]
}
],
"currency": "string",
"dimensions": [
{
"category": "string",
"description": "string",
"includedBaseQuantities": [
{
"isInfinite": true,
"quantity": 0,
"recurringUnit": "Monthly"
}
],
"key": "string",
"name": "string",
"planId": "string",
"planName": "string",
"priceTiers": [
{
"fromAmount": 0,
"price": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"startingUsageAmount": "string"
}
],
"rate": 0,
"skuId": "string",
"types": [
"string"
],
"usageCount": {
"creditCount": 0,
"includedCount": 0,
"reportedCount": 0
},
"valueType": ""
}
],
"dimensionsOversized": true,
"disbursedAmount": 0,
"eulaType": "",
"eulaUrl": "string",
"gcpEntitlements": [
{
"account": "string",
"consumers": [
{
"project": "string"
}
],
"createTime": "2024-07-29T15:51:28.071Z",
"id": "string",
"inputProperties": [
0
],
"messageToUser": "string",
"name": "string",
"newOfferDuration": "string",
"newOfferEndTime": "string",
"newOfferStartTime": "string",
"newPendingOffer": "string",
"newPendingOfferDuration": "string",
"newPendingPlan": "string",
"newPlan": "string",
"offer": "string",
"offerDuration": "string",
"offerEffectiveTime": "2024-07-29T15:51:28.071Z",
"offerEndTime": "2024-07-29T15:51:28.071Z",
"plan": "string",
"product": "string",
"productExternalName": "string",
"provider": "string",
"quoteExternalName": "string",
"state": "ENTITLEMENT_STATE_UNSPECIFIED",
"subscriptionEndTime": "2024-07-29T15:51:28.071Z",
"updateTime": "2024-07-29T15:51:28.071Z",
"usageReportingId": "string"
}
],
"gcpPlans": [
{
"featureValues": [
{
"featureDescription": "string",
"featureName": "string",
"featureTitle": "string",
"featureValue": "string"
}
],
"name": "string",
"priceInfo": {
"description": "string",
"priceModel": "FREE",
"subscriptionPlans": [
{
"period": "string",
"price": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
}
}
],
"usageFees": [
{
"displayQuantity": 0,
"metricId": "string",
"priceTiers": [
{
"fromAmount": 0,
"price": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"startingUsageAmount": "string"
}
]
}
]
},
"purchaseMode": "PURCHASE_MODE_PRIVATE",
"title": "string"
}
],
"gracePeriodInDays": 0,
"grossAmount": 0,
"invoicedAmount": 0,
"netTermsInDays": 0,
"paymentInstallments": [
{
"amount": 0,
"chargeOn": "2024-07-29T15:51:28.071Z",
"chargeOnStr": "string",
"credit": 0,
"discountPercentage": 0,
"originalAmount": 0
}
],
"paymentSchedule": "",
"refundCancellationPolicy": "string",
"sellerNotes": "string",
"spaUrl": "string",
"trialConfig": {
"trialPeriod": 0,
"trialPeriodUnit": "DAY"
}
},
"lastUpdateTime": "2024-07-29T15:51:28.071Z",
"metaInfo": {
"aceApnCrmUniqueIdentifier": "string",
"awsSaasProductDimensions": [
{
"Description": "string",
"Key": "string",
"Length": 0,
"Name": "string",
"Rate": 0,
"TimeUnit": "DAY",
"Types": [
"string"
],
"Unit": "string"
}
],
"baseAgreementId": "string",
"buyerIds": [
"string"
],
"contacts": [
{
"company": "string",
"email": "string",
"name": "string"
}
],
"cppoInOfferId": "string",
"cppoOfferId": "string",
"cppoOutOfferId": "string",
"customMetaInfo": {},
"enableTestUsageMetering": true,
"entitlementCancellationSchedule": {
"cancelDate": "string",
"creationDate": "string",
"note": "string",
"type": "EndOfTerm"
},
"errorMessages": [
"string"
],
"hubspotDealId": "string",
"internalNote": "string",
"isAgreementBasedOffer": true,
"isGrossRevenueFullSync": true,
"isRenewalOffer": true,
"isReplacementOffer": true,
"lastModifiedBy": {
"email": "string",
"entityId": "string",
"entityType": "",
"name": "string"
},
"notifications": [
{
"action": "",
"ccContactIds": [
"string"
],
"channels": [
"EMAIL"
],
"contactEmails": [
"string"
],
"contactIds": [
"string"
],
"createdBy": {
"email": "string",
"entityId": "string",
"entityType": "",
"name": "string"
},
"customFields": {},
"entityID": "string",
"entityName": "string",
"entityStatus": "string",
"entityType": "",
"eventID": "string",
"eventStatus": "",
"isActionItem": true,
"lastUpdateTime": "2024-07-29T15:51:28.071Z",
"message": "string",
"organizationID": "string",
"partner": "",
"priority": "",
"requireAudit": true,
"timestamp": "2024-07-29T15:51:28.071Z",
"title": "string",
"trackEvents": [
{
"action": "OPEN_EMAIL",
"contactId": "string",
"timestamp": "2024-07-29T15:51:28.071Z"
}
]
}
],
"offerAcceptDate": "2024-07-29T15:51:28.071Z",
"renewalOfferType": "",
"replacedOfferEndTime": "2024-07-29T15:51:28.071Z",
"replacedOfferResourceName": "string",
"salesforceEntitlementURL": "string",
"salesforceOpportunityId": "string",
"testUsageMeteringEndTime": "2024-07-29T15:51:28.071Z",
"updateMessage": "string"
},
"name": "string",
"offerID": "string",
"organizationID": "string",
"partner": "",
"productID": "string",
"service": "DEFAULT",
"startTime": "2024-07-29T15:51:28.071Z",
"status": "",
"type": "string"
}
Bad request error
- application/json
- Schema
Schema
string
Not found
- application/json
- Schema
Schema
string
Internal server error
- application/json
- Schema
Schema
string