Skip to main content

List offer sets

GET 
/org/:orgId/offerSet

List offer sets under the given organization with advanced filtering, sorting, and pagination using CRUD query language.

Request​

Path Parameters

    orgId stringrequired

    Organization ID

Query Parameters

    page_size integer

    Number of items per page (default 20, max 1000)

    page_number integer

    Page number (default 1)

    q string

    LISP-style filter expression (e.g., '(= status \

    s string

    Sort fields: 'field:asc,field2:desc' or '-field,field2' format (e.g., 'creation_time:desc,name:asc' or '-creation_time,name')

Body

    object

Responses​

Paginated list of offer sets

Schema

    data

    object[]

  • Array [

    • buyerIDs string[]

    BuyerIds holds the value of the "buyer_ids" field.

    createdBy string

    CreatedBy holds the value of the "created_by" field.

    creationTime date-time

    CreationTime holds the value of the "creation_time" field.

    expireTime date-time

    ExpireTime holds the value of the "expire_time" field.

    externalID string

    ExternalID holds the value of the "external_id" field.

    id string

    ID of the ent.

    info

    object

    Info holds the value of the "info" field.

    awsSolutionID string
    buyerAwsAccountIds string[]
    buyerNotes string
    lastUpdateTime date-time

    LastUpdateTime holds the value of the "last_update_time" field.

    lastUpdatedBy string

    LastUpdatedBy holds the value of the "last_updated_by" field.

    metaInfo

    object

    MetaInfo holds the value of the "meta_info" field.

    aceApnCrmUniqueIdentifier string

    The linked ACE ApnCrmUniqueIdentifier of the private offer if available.

    approvalInfo

    object

    ApprovalInfo holds the value of the "approval_info" field.

    approvalStatus ApprovalStatus (string)

    Possible values: [Submitted, Approved, Declined, Action Required]

    ApprovalStatus holds the current approval status of the offer | "Submitted" | "Approved" | "Declined" | "Action Required";

    decisionDate date-time

    DecisionDate is when the final approval/decline happened (nil when pending) Latest DecisionDate

    message string

    Message is the reason or explanation provided when the approval status is set to Declined or Action Required. It always stores the latest message for the current status transition. Historical messages are stored in notification events.

    requestDate date-time

    Latest RequestDate

    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.

  • Array [

    • Description string
    Key string
    Length integer

    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.

    Name string
    Rate number

    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.

    TimeUnit TimeUnit (string)

    Possible values: [DAY, WEEK, MONTH, YEAR]

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

    Types string[]
    Unit string

  • ]

    • azureBillingAccountID string

    The Azure billing account ID of the buyer for this entitlement. It is populated when syncing Azure private offers or subscriptions.

    azureOriginalOfferIDForUpgrade string

    Original offer ID for Azure Upgrade

    baseAgreementId string

    Applicable for AWS Marketplace only, when the IsAgreementBasedOffer is true.

    buyerIds string[]

    The Suger buyer IDs of the private offer if available.

    chargebeeSubscriptionID string

    The Chargebee subscription ID of the private offer if available.

    contacts

    object[]

    The contacts of the offer to notify if any updates.

  • Array [

    • company string
    email string
    name string

  • ]

    • cppoInOfferId string

    The Suger CPPO_IN offer ID.

    cppoOfferId string

    The Suger CPPO offer ID. Reseller to end buyer

    cppoOutOfferId string

    The Suger CPPO_OUT offer ID. ISV to reseller

    createdByEmail string

    The email address of the user who created the offer. This field is immutable after creation. Especially useful for offers created from Salesforce/HubSpot integrations where the creator may not have a Suger account yet.

    createdBySource CreatedBySource (string)

    Possible values: [``, CONSOLE, SALESFORCE, HUBSPOT, API, CLOUD_PARTNER, AUTO_SHARE]

    The source system that created the offer (CONSOLE, SALESFORCE, HUBSPOT, API). This field is immutable after creation, auto-detected from the authentication context.

    customMetaInfo

    object

    The custom meta info of the offer can be updated by seller via API or console.

    property name* string
    enableTestUsageMetering boolean

    If enabled, Suger will test metering the usage for this entitlement hourly.

    entitlementCancellationSchedule

    object

    The cancellation schedule for the entitlement. It is nill if no cancellation schedule.

    cancelDate date-time

    The cancellation date of the entitlement. It is required when the type is SpecificDate.

    creationDate date-time

    When this cancellation schedule is created.

    note string

    Possible values: <= 500 characters

    The cancellation note. Max 500 characters.

    type CancellationScheduleType (string)

    Possible values: [EndOfTerm, Immediate, SpecificDate]

    Cancellation type

    errorMessages string[]

    The error messages when the offer is invalid or offer related tasks failed. This is the raw error messages from the offer related tasks.

    gcpBillingAccountID string

    The GCP billing account ID of the buyer for this entitlement. It is populated when syncing GCP Marketplace entitlements.

    hubspotDealId string

    Hubsport deal ID of the private offer if available.

    internalNote string

    The Internal note of the private offer. It is only visible to the seller/ISV, not visible to the buyer. Up to MaxInternalNoteLength characters.

    isAgreementBasedOffer boolean

    Applicable for AWS Marketplace only, If this offer is agreement based offer.

    isAzureUpgradeOffer boolean

    If this offer is an Azure upgrade offer.

    isGrossRevenueFullSync boolean

    Whether the gross revenue is fully synced for the entitlement.

    isRenewalOffer boolean

    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.

    isReplacementOffer boolean

    If this offer is a GCP replacement offer. Applicable for GCP Marketplace replacement offer only.

    lastModifiedBy

    object

    The user who last modified the product/offer/buyer/contact.

    email string

    The email of the creator.

    entityId string

    The ID of the creator.

    entityType EntityType (string)

    Possible values: [``, API_CLIENT, AUDITING_EVENT, AUTO_SHARE_TASK, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, FUNDING_APPLICATION, HEADLESS_ENTITLEMENTS, HUBSPOT_USER, INTEGRATION, INTERNAL_ACTION_REQUEST, INVOICE, JOIN_ORG_REQUEST, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SERVICE, SUPPORT_TICKET, UNPURCHASED_OFFERS, USAGE_RECORD_GROUP, USAGE_RECORD_REPORT, USER, WORKFLOW, WORKFLOW_EXECUTION, WORKFLOW_WEBHOOK, ORGANIZATION_INFO]

    The Entity type of the creator, either USER or API_CLIENT.

    name string

    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.

  • Array [

    • action NotificationEventAction (string)

    Possible values: [``, ABNORMAL_ALERT, ACCEPT, ADD, APPROVE, CANCEL, CLOSE, CREATE, DELETE, ARCHIVE, PENDING_CREATE, CREATE_FAILED, ACTIVE, VOID, 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, SIGN, PENDING_PARTNER_ACTION, TERMINATE, ROTATE_SECRET, SUSPEND, TEST, UPDATE, SUBMIT_APPROVAL_REQUEST, REVIEW_APPROVAL_REQUEST, APPROVE_APPROVAL_REQUEST, DECLINE_APPROVAL_REQUEST, COMPLETE, FAIL, WEBHOOK, INBOUND]

    The action of this notification message.

    ccContactIds string[]

    Cc contactIds that will receive this notification

    channels NotificationChannel (string)[]

    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"]

    contactEmails string[]

    Contact emails that will receive this notification

    contactIds string[]

    ContactIds that will receive this notification

    createdBy

    object

    The user who last modified the product/offer/buyer/contact.

    email string

    The email of the creator.

    entityId string

    The ID of the creator.

    entityType EntityType (string)

    Possible values: [``, API_CLIENT, AUDITING_EVENT, AUTO_SHARE_TASK, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, FUNDING_APPLICATION, HEADLESS_ENTITLEMENTS, HUBSPOT_USER, INTEGRATION, INTERNAL_ACTION_REQUEST, INVOICE, JOIN_ORG_REQUEST, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SERVICE, SUPPORT_TICKET, UNPURCHASED_OFFERS, USAGE_RECORD_GROUP, USAGE_RECORD_REPORT, USER, WORKFLOW, WORKFLOW_EXECUTION, WORKFLOW_WEBHOOK, ORGANIZATION_INFO]

    The Entity type of the creator, either USER or API_CLIENT.

    name string

    The name of the creator.

    customFields

    object

    Custom fields of the notification event.

    property name* any

    Custom fields of the notification event.

    entityID string
    entityName string

    The name of the entity.

    entityStatus string
    entityType EntityType (string)

    Possible values: [``, API_CLIENT, AUDITING_EVENT, AUTO_SHARE_TASK, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, FUNDING_APPLICATION, HEADLESS_ENTITLEMENTS, HUBSPOT_USER, INTEGRATION, INTERNAL_ACTION_REQUEST, INVOICE, JOIN_ORG_REQUEST, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SERVICE, SUPPORT_TICKET, UNPURCHASED_OFFERS, USAGE_RECORD_GROUP, USAGE_RECORD_REPORT, USER, WORKFLOW, WORKFLOW_EXECUTION, WORKFLOW_WEBHOOK, ORGANIZATION_INFO]

    The Entity type of the creator, either USER or API_CLIENT.

    eventID string

    notification event id.

    eventStatus NotificationEventStatus (string)

    Possible values: [``, SCHEDULED, PENDING, DONE, FAILED]

    notification event status.

    info

    Additional info of the notification event.

    isActionItem boolean

    If this notification event is an action item.

    lastUpdateTime date-time

    timestamp of the event when it is updated.

    message string

    The message of the notification event such as email body, action item description.

    organizationID string

    suger organization id.

    partner Partner (string)

    Possible values: [``, ADYEN, ALIBABA, ANTHROPIC, AWS, AWS_CHINA, AZURE, CHARGEBEE, DATABRICKS, DOCUSIGN, DNS, GCP, GONG, GOOGLE, HUBSPOT, INTUIT, LAGO, MARKETO, METRONOME, MICROSOFT, OPENAI, ORACLE, ORB, REDHAT, SALESFORCE, SLACK, SNOWFLAKE, STRIPE, ZOHO, OAUTH2, SALESFORCE, HUBSPOT, AWS, AZURE, GCP]

    The partner where this usage metering daily record is from. Such as AWS, AZURE or GCP.

    priority AuditingEventPriority (string)

    Possible values: [``, LOW, MEDIUM, HIGH, CRITICAL]

    The priority of the notification event.

    requireAudit boolean

    If this notification event is an auditing event and need to store in DB.

    timestamp date-time

    timestamp of the event when it is scheduled or created.

    title string

    The title of the notification event such as email subject, action item title.

    trackEvents

    object[]

    The track events of the notification event.

  • Array [

    • action TrackEventActionType (string)

    Possible values: [OPEN_EMAIL]

    contactId string

    The ID of the contact who triggered the track event if applicable.

    timestamp date-time

    timestamp of the track event happened.

  • ]

  • ]

    • offerAcceptDate date-time

    The date when the offer is accepted by the buyer. Only available when the private offer has been accepted.

    offerCreationSuccessDate date-time

    The datetime when the offer was successfully created on the partner's marketplace (AWS, Azure, GCP, etc).

    originalEulaInfo

    object

    Original EULA info of the offer. It is used to store the original EULA info of the offer. used for clone offer.

    additionalEulaUrls string[]

    The URL of the additional EULA files. Only applicable when EulaType = CUSTOM. The additional EULA files will be attached to the EULA file in the EulaUrl, and form a single EULA file.

    additionalResellerEulaUrls string[]

    The URL of the additional reseller EULA files. Only applicable when ResellerEulaType = CUSTOM.

    attachEulaType EulaType (string)

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

    Attach the standard EULA file to the CUSTOM EULA file. Only applicable when EulaType = CUSTOM

    eulaMergeOrder integer[]

    The merge order of the EULA files. Only applicable when EulaType = CUSTOM. Elements are the original index of the EULA files in the index they should be transferred to, where original indexes are: AttachEulaType is index 0, EulaUrl is index 1, additionalEulaUrls is index 2 onwards.

    eulaType EulaType (string)

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

    Attach the standard EULA file to the CUSTOM EULA file. Only applicable when EulaType = CUSTOM

    eulaUrl string

    The URL of the EULA file.

    resellerAttachEulaType EulaType (string)

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

    Attach the standard EULA file to the CUSTOM EULA file. Only applicable when EulaType = CUSTOM

    resellerEulaType EulaType (string)

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

    Attach the standard EULA file to the CUSTOM EULA file. Only applicable when EulaType = CUSTOM

    resellerEulaUrl string
    prettifiedErrorMessages string[]

    The prettified ErrorMessages. Using AI to make it more readable and understandable. The prettified error messages will be used for the offer related UI display.

    renewalOfferType AwsRenewalOfferType (string)

    Possible values: [``, External, AwsMarketplace]

    Indicates if the existing agreement was signed outside AWS Marketplace or within AWS Marketplace. one of values ["External", "AwsMarketplace"]

    replacedOfferEndTime date-time

    The end time of the replaced offer. Applicable for GCP Marketplace replacement offer only.

    replacedOfferResourceName string

    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.

    replacedResellerPrivateOfferPlan string

    The resource name of the GCP marketplace reseller private offer plan that this offer is replacing. In format of "resellerPrivateOfferPlans/{resellerOfferPrivatePlanId}"

    resellerIds string[]

    The reseller IDs (in the identity.buyer table) associated with this offer. Only applicable for CPPO_OUT & CPPO offers.

    salesforceEntitlementURL string

    The Salesforce entitlement URL

    salesforceOpportunityId string

    The Salesforce opportunity ID of the private offer if available.

    salesforceQuoteId string

    The Salesforce Quote ID of the private offer if available.

    testUsageMeteringEndTime date-time

    The test usage metering end time. It is used for test usage metering only. Required if EnableTestUsageMetering is true.

    updateMessage string

    The message to notify when the offer is updated.

    warningMessages string[]

    Warning messages for non-blocking issues that were auto-fixed. For example, deal type auto-fix when Native Renewal eligibility criteria are not met.

    name string

    Name holds the value of the "name" field.

    offerIDs string[]

    OfferIds holds the value of the "offer_ids" field.

    organizationID string

    OrganizationID holds the value of the "organization_id" field.

    partner string

    Partner holds the value of the "partner" field.

    partnerID string

    PartnerID holds the value of the "partner_id" field.

    service string

    Service holds the value of the "service" field.

    status string

    Status holds the value of the "status" field.

  • ]

    • page_number integer
    page_size integer
    total_count integer
Loading...