update offer meta info
PATCH/org/:orgId/offer/:offerId/metaInfo
Update the meta info of the given offer.
Request
Path Parameters
Organization ID
Offer ID
- application/json
Body
required
Offer meta info to update
Array [
]
Array [
]
Array [
Array [
]
]
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: [``, ABNORMAL_PAYMENT_TRANSACTIONS, API_CLIENT, AUDITING_EVENT, AUTO_SHARE_TASK, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, HEADLESS_ENTITLEMENTS, INTEGRATION, INVOICE, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, WORKFLOW, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SUPPORT_TICKET, UNPURCHASED_OFFERS, USER]
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, 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: [``, ABNORMAL_PAYMENT_TRANSACTIONS, API_CLIENT, AUDITING_EVENT, AUTO_SHARE_TASK, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, HEADLESS_ENTITLEMENTS, INTEGRATION, INVOICE, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, WORKFLOW, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SUPPORT_TICKET, UNPURCHASED_OFFERS, USER]
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: [``, ABNORMAL_PAYMENT_TRANSACTIONS, API_CLIENT, AUDITING_EVENT, AUTO_SHARE_TASK, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, HEADLESS_ENTITLEMENTS, INTEGRATION, INVOICE, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, WORKFLOW, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SUPPORT_TICKET, UNPURCHASED_OFFERS, USER]
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.
Responses
- 200
- 400
- 405
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Array [
Array [
]
]
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: [``, ABNORMAL_PAYMENT_TRANSACTIONS, API_CLIENT, AUDITING_EVENT, AUTO_SHARE_TASK, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, HEADLESS_ENTITLEMENTS, INTEGRATION, INVOICE, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, WORKFLOW, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SUPPORT_TICKET, UNPURCHASED_OFFERS, USER]
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, 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: [``, ABNORMAL_PAYMENT_TRANSACTIONS, API_CLIENT, AUDITING_EVENT, AUTO_SHARE_TASK, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, HEADLESS_ENTITLEMENTS, INTEGRATION, INVOICE, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, WORKFLOW, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SUPPORT_TICKET, UNPURCHASED_OFFERS, USER]
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: [``, ABNORMAL_PAYMENT_TRANSACTIONS, API_CLIENT, AUDITING_EVENT, AUTO_SHARE_TASK, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, HEADLESS_ENTITLEMENTS, INTEGRATION, INVOICE, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, WORKFLOW, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SUPPORT_TICKET, UNPURCHASED_OFFERS, USER]
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.
{
"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"
}
Bad request error
- application/json
- Schema
Schema
string
Method not allowed
- application/json
- Schema
Schema
string
Internal error
- application/json
- Schema
Schema
string