Skip to main content

List organizations

GET 

/org

List all organizations of the requesting caller. The caller can be a user or an API client.

Request

Body

    object

Responses

Success

Schema

  • Array [

  • allowedAuthMethods string[]
    authID string
    createdBy string
    creationTime date-time
    description string
    emailDomain string
    expireAt date-time

    nullable

    id string

    info

    object

    aiBillingConfig

    object

    Store the AI billing configuration information of the organization. Used for Stripe-based AI usage billing.

    billingEmail string

    Override email for invoice delivery. If empty, invoices go to the org creator's email.

    disabledAt date-time

    When AI usage was disabled, if applicable.

    disabledReason AIBillingDisabledReason (string)

    Possible values: [SPENDING_CAP_REACHED, MANUAL, PAYMENT_OVERDUE]

    Reason for AI usage being disabled, if applicable. Valid values: SPENDING_CAP_REACHED, MANUAL, PAYMENT_OVERDUE

    enabled boolean

    Whether AI usage billing is enabled for this organization. Default is true. Set to false to disable AI features.

    monthlyCreditCents integer

    Monthly credit in cents. Default is 10000 ($100). Set to 0 for no credit, or a custom value for VIP customers.

    monthlySpendingCapCents integer

    Monthly spending cap in cents. Default is 50000 ($500). Set to nil for unlimited spending.

    clientSignupPageConfigInfo

    object

    Store the new client signup page configuration information of the organization.

    ccEmails string[]

    The cc email contacts of the new client signup notification.

    companyLogoUrl string

    The company logo url of the seller/ISV.

    companyName string

    The company name of the seller/ISV to show in the client signup page.

    customEmailTemplate string

    Custom email template used as template

    customTemplate string

    Custom template used as template

    enableCustomEmailTemplate boolean

    If true, custom email template will be used

    enableCustomTemplate boolean

    If true, custom template will be used

    enableHeadlessEntitlementsReport boolean

    Enable headless entitlements report. Once enabled, the headless entitlements report will be sent as notification events. Each report contains the headless entitlements who are created in the past 3 days, but never have new client signup connected.

    enableUpdateBuyer boolean

    Enable to update buyer information with the new client signup info. If true, the buyer information will be updated with the new client signup info. If false, the buyer information will not be updated with the new client signup info.

    hideCloudPartnerLogo boolean

    If true, the cloud partner logo will no show in the new client signup page.

    landingImageUrl string

    The signup landing image aws url of the organization

    notificationEmailSubject string

    The email subject of the new client signup notification.

    publicNotes string

    The public notes to append in new client signup notification email.

    signupId string

    The signup ID for the new client signup page url. It is populated by Suger service when creating the new client signup page.

    videoLink string

    The video link of the product. Optional.

    cosellConfigInfoV2

    object[]

    Store the cosell configuration information of the organization.

  • Array [

  • cloudPartner Partner (string)

    Possible values: [``, ADYEN, ALIBABA, ANTHROPIC, AWS, AWS_CHINA, AZURE, CHARGEBEE, DATABRICKS, DOCUSIGN, DNS, GCP, GONG, GOOGLE, GITHUB, 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.

    crmPartner Partner (string)

    Possible values: [``, ADYEN, ALIBABA, ANTHROPIC, AWS, AWS_CHINA, AZURE, CHARGEBEE, DATABRICKS, DOCUSIGN, DNS, GCP, GONG, GOOGLE, GITHUB, 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.

    info

    object

    aceHubspot

    object

    autoShareEnabled boolean

    options for AutoShare

    autoShareHubspotLists

    object[]

  • Array [

  • createdAt date-time
    createdById string
    deletedAt date-time

    filterBranch

    object

    Required parameters when creating a list that processingType is DYNAMIC or SNAPSHOT

    filterBranchOperator string
    filterBranchType string
    filterBranches undefined[]

    filters

    object[]

  • Array [

  • filterType string

    operation

    object

    operationType string
    operator string
    value
    values undefined[]
    property string
  • ]

  • filtersUpdatedAt date-time
    listId string
    listVersion integer
    name string

    Required parameters when creating a list

    objectTypeId string

    Required parameters when creating a list

    processingStatus string
    processingType string

    Required parameters when creating a list

    size integer
    updatedAt date-time
    updatedById string
  • ]

  • checkToLaunchField string

    cloudPartnerDefaultValues

    object

    property name* any
    companyAssociationType integer

    Other options

    companySyncMode string
    contactAssociationType integer
    contactSyncMode string

    crmPartnerDefaultValues

    object

    property name* any

    dealPipelineIdToStageMapping

    object

    Key: Deal pipeline ID. Value: Bi-directional map between AWS stage and deal stage. No need to store default stage for contacts and companies. We can use the CRMPartnerDefaultValue to store that.

    property name*

    structs.BiStrMap

    backward

    object

    property name* string

    forward

    object

    property name* string
    expectedMonthlyAwsRevenueFactor number

    options for expectedMonthlyAwsRevenue Whatever field mapped to expectedMonthlyAwsRevenue, apply this factor on that field to auto-calculate the value.

    fieldMappings

    object[]

  • Array [

  • cloudPartnerDefaultValue

    TODO remove this.

    cloudPartnerField string
    crmPartnerDefaultValue
    crmPartnerField string

    picklistMap

    object

    property name* string

    picklistMapReversed

    object

    property name* string
    syncMode string
  • ]

  • objectTypeToDefaultPipelineId

    object

    Key: Object Type (deals, companies, contacts). Value: Default pipeline ID to use when accepting inbound referrals.

    property name* string

    aceSalesforce

    object

    accountAddressSyncMode string
    accountAddressType string

    shipping or billing

    accountRecordType string

    options for "Customer Company"

    aceDefaultIndustry string
    aceDefaultIndustryOther string
    autoShareConditions string
    autoShareEnabled boolean

    options for AutoShare

    cloudPartnerDefaultValues

    object

    property name* any
    contactRecordType string

    options for "Customer End User Contact"

    contactRole string
    contactSyncMode string

    crmPartnerDefaultValues

    object

    Default values. They take precedence over field mappings.

    property name* any

    Default values. They take precedence over field mappings.

    customerContactSharingEnabled boolean

    options for sharing contacts outbound

    enabled boolean

    Overall switch - nothing will be applied if not enabled.

    expectedMonthlyAwsRevenueFactor number

    options for expectedMonthlyAwsRevenue Whatever field mapped to expectedMonthlyAwsRevenue, apply this factor on that field to auto-calculate the value.

    fieldMappings

    object[]

  • Array [

  • cloudPartnerDefaultValue

    TODO remove this.

    cloudPartnerField string
    crmPartnerDefaultValue
    crmPartnerField string

    picklistMap

    object

    property name* string

    picklistMapReversed

    object

    property name* string
    syncMode string
  • ]

  • hashtags string[]

    options for applying hashtags in the project title

    isvPrimaryContactSharingEnabled boolean
    opportunityRecordType string
    setCustomerContactAsPrimary boolean

    aceSalesforceV2

    object

    property name*

    structs.CosellAceSalesforceConfigInfo

    accountAddressSyncMode string
    accountAddressType string

    shipping or billing

    accountRecordType string

    options for "Customer Company"

    aceDefaultIndustry string
    aceDefaultIndustryOther string
    autoShareConditions string
    autoShareEnabled boolean

    options for AutoShare

    cloudPartnerDefaultValues

    object

    property name* any
    contactRecordType string

    options for "Customer End User Contact"

    contactRole string
    contactSyncMode string

    crmPartnerDefaultValues

    object

    Default values. They take precedence over field mappings.

    property name* any

    Default values. They take precedence over field mappings.

    customerContactSharingEnabled boolean

    options for sharing contacts outbound

    enabled boolean

    Overall switch - nothing will be applied if not enabled.

    expectedMonthlyAwsRevenueFactor number

    options for expectedMonthlyAwsRevenue Whatever field mapped to expectedMonthlyAwsRevenue, apply this factor on that field to auto-calculate the value.

    fieldMappings

    object[]

  • Array [

  • cloudPartnerDefaultValue

    TODO remove this.

    cloudPartnerField string
    crmPartnerDefaultValue
    crmPartnerField string

    picklistMap

    object

    property name* string

    picklistMapReversed

    object

    property name* string
    syncMode string
  • ]

  • hashtags string[]

    options for applying hashtags in the project title

    isvPrimaryContactSharingEnabled boolean
    opportunityRecordType string
    setCustomerContactAsPrimary boolean

    azureHubspot

    object

    cloudPartnerDefaultValues

    object

    property name* any

    crmPartnerDefaultValues

    object

    Default values

    property name* any

    Default values

    fieldMappings

    object[]

  • Array [

  • cloudPartnerDefaultValue

    TODO remove this.

    cloudPartnerField string
    crmPartnerDefaultValue
    crmPartnerField string

    picklistMap

    object

    property name* string

    picklistMapReversed

    object

    property name* string
    syncMode string
  • ]

  • outboundStageMapping

    object

    Outbound Stage Mapping

    property name* string
    preferMicrosoftManagedAccount boolean

    Prefer Microsoft Managed Account

    shareContact boolean

    Options for sharing contacts/owners outbound

    shareOwner boolean

    azureSalesforce

    object

    accountAddressType string

    Use shipping or billing

    cloudPartnerDefaultValues

    object

    property name* any

    crmPartnerDefaultValues

    object

    Default values

    property name* any

    Default values

    enableSalesStageSync boolean

    Enable Sales Stage Sync

    fieldMappings

    object[]

  • Array [

  • cloudPartnerDefaultValue

    TODO remove this.

    cloudPartnerField string
    crmPartnerDefaultValue
    crmPartnerField string

    picklistMap

    object

    property name* string

    picklistMapReversed

    object

    property name* string
    syncMode string
  • ]

  • outboundStageMapping

    object

    Outbound Stage Mapping

    property name* string
    preferMicrosoftManagedAccount boolean

    Prefer Microsoft Managed Account

    shareContact boolean

    Options for sharing contacts/owners outbound

    shareOwner boolean
  • ]

  • cosellFillerConfigInfo

    object[]

    Store the cosell configuration fillers

  • Array [

  • from Partner (string)

    Possible values: [``, ADYEN, ALIBABA, ANTHROPIC, AWS, AWS_CHINA, AZURE, CHARGEBEE, DATABRICKS, DOCUSIGN, DNS, GCP, GONG, GOOGLE, GITHUB, 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.

    lastModifyTime date-time

    LastModifyTime is the last modify time of the from-to configuration.

    mappingInfo

    object

    MappingInfo contains the detailed field mappings, sync rules, and automation settings that control how data is transformed between the partner systems

    aoMirroringConfig

    object

    enabled boolean
    pipeline string

    ID of the HubSpot pipeline

    stage string

    ID of the stage in the pipeline

    autoAcceptEnabled boolean

    options for AutoAccept referrals from partner (inbound) Deprecated

    autoCreateInboundContact boolean
    autoDeleteEnabled boolean

    options for AutoDelete rejected referrals (outbound) Deprecated

    autoEnrichOutboundReferral boolean

    AutoEnrichOutboundReferral is the option to auto-enrich the outbound referrals by the enrichment service.

    autoShare

    object

    autoShareHubspotLists

    object[]

  • Array [

  • listId string
    name string
    objectTypeId string
  • ]

  • conditions string
    enabled boolean
    frequency string

    autoUpdateAccount

    object

    options for AutoUpdate salesforce account upon some condition

    condition structs.CosellAutoUpdateAccountCondition (string)

    Possible values: [referralAccepted]

    enabled boolean
    fillers object[]

    autoUpdateContact

    object

    options for AutoUpdate salesforce contact when AWS contacts are available

    accountOrCompanyID string
    contactsToUpdate string[]
    enabled boolean

    autoUpdateOpportunity

    object

    options for AutoUpdate salesforce opportunity upon some condition

    condition structs.CosellAutoUpdateOppCondition (string)

    Possible values: [referralAccepted]

    enabled boolean
    fillers object[]
    fillers object[]
    preAcceptanceWebhook string

    PreAcceptanceWebhook is the webhook URL to call before accepting the inbound referral. Inbound referrals from Microsoft Partner Center may miss some fields, such as team member, deal value, etc. Without populating them first, the referral acceptance is impossible. And in the async mode where the referral acceptance is triggered by a SFDC flow, we need to rely on this highly customizable webhook to populate the missing fields first.

    to Partner (string)

    Possible values: [``, ADYEN, ALIBABA, ANTHROPIC, AWS, AWS_CHINA, AZURE, CHARGEBEE, DATABRICKS, DOCUSIGN, DNS, GCP, GONG, GOOGLE, GITHUB, 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.

    version string

    Version indicates the configuration schema version for backward compatibility. The default value is an empty string.

  • ]

  • cosellIntelligenceConfigInfo

    object

    Store the cosell intelligence configuration information of the organization.

    awsSignalsEnabled boolean

    Per-cloud signal toggles are optional. We use *bool so we can distinguish three states:

    • nil: not set — fall back to the legacy/global CosellIntelligenceSignalsEnabled value
    • true: explicitly enabled for this cloud
    • false: explicitly disabled for this cloud

    This preserves backward compatibility for orgs that only have the legacy field set while allowing clients to make explicit per-cloud overrides. AwsSignalsEnabled controls whether AWS co-sell intelligence signals are enabled

    azureSignalsEnabled boolean

    AzureSignalsEnabled controls whether Azure co-sell intelligence signals are enabled

    cosellIntelligenceSignalsEnabled boolean

    CosellIntelligenceSignalsEnabled controls whether co-sell intelligence signals are enabled for the organization

    gcpSignalsEnabled boolean

    GcpSignalsEnabled controls whether GCP co-sell intelligence signals are enabled

    notificationConfigInfo

    object

    Store the notification configuration information of the organization.

    allEmailNotificationScopes NotificationScope (string)[]

    Possible values: [``, CREATE.PRODUCT, UPDATE.PRODUCT, DELETE.PRODUCT, CREATE.OFFER, ACCEPT.OFFER, EXPIRE.OFFER, UPDATE.OFFER, DELETE.OFFER, CANCEL.OFFER, OPEN_EMAIL.OFFER, SUBMIT_APPROVAL_REQUEST.OFFER, REVIEW_APPROVAL_REQUEST.OFFER, NOTIFY_CONTACTS.OFFER, PENDING_ACCEPTANCE.OFFER, PENDING_PARTNER_ACTION.OFFER, EXPIRE_SOON.OFFER, NOTIFY.UNPURCHASED_OFFERS, CREATE.ENTITLEMENT, REINSTATE.ENTITLEMENT, SUSPEND.ENTITLEMENT, PENDING_CANCEL.ENTITLEMENT, CANCEL.ENTITLEMENT, UPDATE.ENTITLEMENT, METER.ENTITLEMENT, END_SOON.ENTITLEMENT, TERMINATE.ENTITLEMENT, NOTIFY.HEADLESS_ENTITLEMENTS, CREATE.FUNDING_APPLICATION, UPDATE.FUNDING_APPLICATION, APPROVE.FUNDING_APPLICATION, REJECT.FUNDING_APPLICATION, CREATE.API_CLIENT, DELETE.API_CLIENT, ROTATE_SECRET.API_CLIENT, MERGE.BUYER, CREATE.ORGANIZATION, UPDATE.ORGANIZATION, APPROVE.ORGANIZATION, CREATE.USER, ADD.USER, DELETE.USER, UPDATE.USER, CREATE.INTEGRATION, UPDATE.INTEGRATION, DELETE.INTEGRATION, CREATE.SUPPORT_TICKET, CLOSE.SUPPORT_TICKET, REOPEN.SUPPORT_TICKET, CREATE.WORKFLOW, UPDATE.WORKFLOW, DELETE.WORKFLOW, FAIL.WORKFLOW_EXECUTION, NEW_CLIENT_SIGNUP.NOTIFICATION_MESSAGE, DISBURSE.REVENUE_RECORD, COMPLETE.AUTO_SHARE_TASK, FAIL.AUTO_SHARE_TASK, ARCHIVE.REFERRAL, CREATE.REFERRAL, UPDATE.REFERRAL, ACCEPT.REFERRAL, REJECT.REFERRAL, PENDING_ACCEPTANCE.REFERRAL, APPROVE.REFERRAL, INBOUND.REFERRAL]

    All available email notification scopes for the organization. It is used to populate the UI. The emailNotificationScopeList should be a subset of allEmailNotificationScopes.

    daysToExpireSoonOfferWorkflowNotification integer

    The number of days before offer expiration to trigger the workflow notification. Only applicable when EnableExpireSoonOfferWorkflowNotification is true. Default is 7 days if not specified.

    disableEmailNotificationOnOfferReady boolean

    Enable to email notification events to buyers

    emailNotificationScopeConfigs

    object[]

    The list of email notification scope configs that defines which NotificationScopes are sent to which emails. Only applicable when EnableEmailNotification is true.

  • Array [

  • bccRecipients

    object[]

    The BCC email recipients who will receive this email notifications

  • Array [

  • creationTime string
    email string
    firstName string
    id string
    lastName string
    lastUpdateTime string
  • ]

  • ccRecipients

    object[]

    The CC email recipients who will receive this email notifications

  • Array [

  • creationTime string
    email string
    firstName string
    id string
    lastName string
    lastUpdateTime string
  • ]

  • notificationScopeFilters

    object

    The notification scope filter that define granularity filters to decide whether the event matches the scope. When using this filter, make sure to have a single notification scope in the NotificationScopes.

    filterArgs
    notificationScopes NotificationScope (string)[]

    Possible values: [``, CREATE.PRODUCT, UPDATE.PRODUCT, DELETE.PRODUCT, CREATE.OFFER, ACCEPT.OFFER, EXPIRE.OFFER, UPDATE.OFFER, DELETE.OFFER, CANCEL.OFFER, OPEN_EMAIL.OFFER, SUBMIT_APPROVAL_REQUEST.OFFER, REVIEW_APPROVAL_REQUEST.OFFER, NOTIFY_CONTACTS.OFFER, PENDING_ACCEPTANCE.OFFER, PENDING_PARTNER_ACTION.OFFER, EXPIRE_SOON.OFFER, NOTIFY.UNPURCHASED_OFFERS, CREATE.ENTITLEMENT, REINSTATE.ENTITLEMENT, SUSPEND.ENTITLEMENT, PENDING_CANCEL.ENTITLEMENT, CANCEL.ENTITLEMENT, UPDATE.ENTITLEMENT, METER.ENTITLEMENT, END_SOON.ENTITLEMENT, TERMINATE.ENTITLEMENT, NOTIFY.HEADLESS_ENTITLEMENTS, CREATE.FUNDING_APPLICATION, UPDATE.FUNDING_APPLICATION, APPROVE.FUNDING_APPLICATION, REJECT.FUNDING_APPLICATION, CREATE.API_CLIENT, DELETE.API_CLIENT, ROTATE_SECRET.API_CLIENT, MERGE.BUYER, CREATE.ORGANIZATION, UPDATE.ORGANIZATION, APPROVE.ORGANIZATION, CREATE.USER, ADD.USER, DELETE.USER, UPDATE.USER, CREATE.INTEGRATION, UPDATE.INTEGRATION, DELETE.INTEGRATION, CREATE.SUPPORT_TICKET, CLOSE.SUPPORT_TICKET, REOPEN.SUPPORT_TICKET, CREATE.WORKFLOW, UPDATE.WORKFLOW, DELETE.WORKFLOW, FAIL.WORKFLOW_EXECUTION, NEW_CLIENT_SIGNUP.NOTIFICATION_MESSAGE, DISBURSE.REVENUE_RECORD, COMPLETE.AUTO_SHARE_TASK, FAIL.AUTO_SHARE_TASK, ARCHIVE.REFERRAL, CREATE.REFERRAL, UPDATE.REFERRAL, ACCEPT.REFERRAL, REJECT.REFERRAL, PENDING_ACCEPTANCE.REFERRAL, APPROVE.REFERRAL, INBOUND.REFERRAL]

    the notification scopes that define which type of notification events shall be sent to the Recipients.

    recipients

    object[]

    The email recipients who will receive this email notifications

  • Array [

  • creationTime string
    email string
    firstName string
    id string
    lastName string
    lastUpdateTime string
  • ]

  • ]

  • emailNotificationScopeEventConfigs

    object

    The per-scope-event email notification configurations. The key is the NotificationScope (e.g., "CREATE.OFFER"). Each scope has its own independent config with enabled state, recipients, and optional template override. This replaces the legacy EmailNotificationScopeConfigs and EmailNotificationScopeTemplates fields. When this map is populated, it takes precedence over the legacy fields.

    property name*

    EmailNotificationScopeEventConfig

    bccRecipients

    object[]

    The BCC email recipients for this scope.

  • Array [

  • creationTime string
    email string
    firstName string
    id string
    lastName string
    lastUpdateTime string
  • ]

  • ccRecipients

    object[]

    The CC email recipients for this scope.

  • Array [

  • creationTime string
    email string
    firstName string
    id string
    lastName string
    lastUpdateTime string
  • ]

  • enabled boolean

    Whether this specific scope is enabled for email notifications. When false, no emails are sent for events matching this scope.

    recipients

    object[]

    The TO email recipients for this scope.

  • Array [

  • creationTime string
    email string
    firstName string
    id string
    lastName string
    lastUpdateTime string
  • ]

  • templateId string

    The ID of the notification template assigned to this scope. Empty string means no custom template -- use default.

    emailNotificationScopeTemplates

    object

    The email templates for the notification scopes. The key is the notification scope. The value is the email template ID. Each notification scope has a default email template if not specified. Which can be overridden by setting the email template in this field.

    property name* string
    enableEmailNotification boolean

    Enable to email notification events to organization admins/editors. The default is false, and does not send emails to organization admins/editors.

    enableExpireSoonOfferWorkflowNotification boolean

    Enable to send workflow notifications when offers are expiring soon. The default is false, and does not send expire soon offer workflow notifications.

    enableWebhookNotification boolean

    Enable the product whitelist for the webhook notification. The default is false, and allow all the products notifications sent via webhook.

    supportSlackChannelID string

    ID of slack channel for suger customer support

    webhookProductWhitelist string[]

    The product whitelist (suger Product Id) for the webhook notification. If the product is not in the whitelist, the notification will be sent via webhook.

    offerFillerConfigInfos

    object[]

    Store the offer preview by field-mapping-v2 filler configs Deprecated

  • Array [

  • from Partner (string)

    Possible values: [``, ADYEN, ALIBABA, ANTHROPIC, AWS, AWS_CHINA, AZURE, CHARGEBEE, DATABRICKS, DOCUSIGN, DNS, GCP, GONG, GOOGLE, GITHUB, 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.

    mappingInfo

    object

    fillers object[]
    to Partner (string)

    Possible values: [``, ADYEN, ALIBABA, ANTHROPIC, AWS, AWS_CHINA, AZURE, CHARGEBEE, DATABRICKS, DOCUSIGN, DNS, GCP, GONG, GOOGLE, GITHUB, 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.

  • ]

  • offerFillerCrmPartnerConfigInfos

    object

    Deprecated

    property name*

    OfferFillerCrmPartnerConfigInfo

    offerFillerSelectionConfig object[]
    sourceObjectType string

    organizationConfigInfo

    object

    Store the basic configuration information of the organization.

    auth0ApplicationClientId string

    The Client ID of the custom auth0 application. This is used to allow login with the custom SSO.

    auth0EnterpriseConnectionName string

    The auth0 connection name which is used for Identity Provider (IdP) Initiated SSO

    auth0OrganizationId string

    Auth0 Organization ID when using Auth0 Organizations (new SSO configuration)

    authProvider AuthProvider (string)

    Possible values: [auth0]

    Authentication provider. e.g., Auth0

    enableProductWhitelist boolean

    Enable the product whitelist for the organization.

    enableReseller boolean

    Whether to enable reseller (CPPO-in) UI for the organization. When false (default), all "As Reseller" toggles, "Show Resale" toggles for CPPO-in products, and the "Received" tab on the Resale page are hidden. When true, the organization can act as a reseller and create CPPO-in offers.

    enableSalesforceAwsFieldMappingV2 boolean

    Whether to use new filler filed mapping

    enableSugerHookTrigger boolean

    Whether to enable Suger hook trigger

    enforceCustomLogin boolean

    Whether to enforce the custom SSO login via the custom auth0 application. If true, the user can only login via the custom auth0 application. If false, the user can login via the custom auth0 application, or the default Suger auth0 application.

    productWhitelist string[]

    The product whitelist for the organization.

    privateOfferConfigInfo

    object

    Store the private offer configuration information of the organization. TODO: migrate the OfferFillerConfigInfos & OfferFillerCrmPartnerConfigInfos to PrivateOfferConfigInfo.

    enableListProductFilter boolean

    Enable the filter on the product listing API. Default is false.

    hubspotFieldMappingConfig

    object

    The config info for offer field mapping from a hubspot object

    awsFillers object[]

    All field mapping rules for each AWS Offer field.

    azureFillers object[]

    All field mapping rules for each Azure Offer field.

    gcpFillers object[]

    All field mapping rules for each GCP Offer field.

    partnerSelectExpression string

    For some customers, it’s necessary to select the target cloud partner based on the data from the source Salesforce object. For example, if the Opportunity object has a field named Marketplace__c, we can use the expression {{ .Marketplace__c }} to evaluate its value and determine the target cloud partner. If Marketplace__c is set to AWS, the opportunity will be mapped to an AWS Offer, The evaluated result is expected to be one of AWS, Azure, or GCP.

    sourceObjectType string

    The type of source CRM object, usually an Opportunity or an CPQ Quote in Salesforce In Hubspot, it is always a Deal object for now

    listProductFilterCode string

    The product filter code (Javascript) for the product listing API if enabled. It is executed in a secure JS sandbox environment to filter the products.

    salesforceFieldMappingConfig

    object

    The config info for offer field mapping from a hubspot object

    awsFillers object[]

    All field mapping rules for each AWS Offer field.

    azureFillers object[]

    All field mapping rules for each Azure Offer field.

    gcpFillers object[]

    All field mapping rules for each GCP Offer field.

    partnerSelectExpression string

    For some customers, it’s necessary to select the target cloud partner based on the data from the source Salesforce object. For example, if the Opportunity object has a field named Marketplace__c, we can use the expression {{ .Marketplace__c }} to evaluate its value and determine the target cloud partner. If Marketplace__c is set to AWS, the opportunity will be mapped to an AWS Offer, The evaluated result is expected to be one of AWS, Azure, or GCP.

    sourceObjectType string

    The type of source CRM object, usually an Opportunity or an CPQ Quote in Salesforce In Hubspot, it is always a Deal object for now

    ssoConfigInfo

    object

    Store the SSO configuration information of the organization.

    auth0OrganizationId string

    The Auth0 organization ID mapped to this Suger organization

    auth0OrganizationName string

    The Auth0 organization name

    connections

    object[]

    List of SSO connections configured for this organization

  • Array [

  • createdAt date-time

    When the connection was created

    enabled boolean

    Whether the connection is enabled

    id string

    The Auth0 connection ID

    metadata

    object

    Additional metadata about the connection

    property name* any

    Additional metadata about the connection

    name string

    The connection name

    strategy string

    The connection strategy (samlp, oidc, etc.)

  • ]

  • lastConfiguredAt date-time

    When SSO was last configured

    lastConfiguredBy string

    User ID who last configured SSO

    maxConnections integer

    Maximum number of connections allowed (default 2)

    selfServiceProfileId string

    The self-service profile ID used for ticket creation

    usageMeteringConfigInfo

    object

    Store the usage metering configuration information of the organization.

    partnerUsageMeteringConfigs

    object[]

    The usage metering configuration for each Partner, such as AWS, AZURE & GCP.

  • Array [

  • dimensionMapping

    object

    Deprecated: Use DimensionMappingV2 instead. The mapping of the source dimension key to the destination dimension key of the usage metering.

    property name*

    UsageMeteringDimensionMappingValue

    convertionMultiplier number

    The convertion multiplier when mapping from the source dimension key to the destination dimensionKey by quantity mode. Not required if the mapping mode is AMOUNT.

    dimensionKey string

    The destination dimension key of the usage metering mapping.

    mappingMode UsageMeteringDimensionMappingMode (string)

    Possible values: [``, QUANTITY, AMOUNT]

    The conversion mode of UsageMeteringDimensionMapping. The default is QUANTITY if not available.

    dimensionMappingV2

    object

    The mapping of the source dimension key to the destination dimension keys of the usage metering. The destination dimension keys are the list of the destination dimension keys. So the source dimension key can be mapped to multiple destination dimension keys.

    property name*

    object[]

  • Array [

  • convertionMultiplier number

    The convertion multiplier when mapping from the source dimension key to the destination dimensionKey by quantity mode. Not required if the mapping mode is AMOUNT.

    dimensionKey string

    The destination dimension key of the usage metering mapping.

    mappingMode UsageMeteringDimensionMappingMode (string)

    Possible values: [``, QUANTITY, AMOUNT]

    The conversion mode of UsageMeteringDimensionMapping. The default is QUANTITY if not available.

  • ]

  • enableBillableDimension boolean
    enableCommitWithAdditionalUsageAtListPrice boolean

    Enable the commit (discount) with additional usage metering at list price. Only applicable if EnableCommitWithAdditionalUsageMetering is true. The default is false, which means the commit with additional usage metering at the discounted price in the private offer. If set to true, the additional usage is metered at the list price (the price in public product listing) instead of the discounted price.

    enableCommitWithAdditionalUsageMetering boolean

    Enable the commit with additional usage metering. The default is false, which means all usage records are reported to partner no matter how much is the commit. If set to true, the usage records will be reported to partner only if the current commit has been exhausted.

    enableDimensionMapping boolean

    Enable the dimension mapping for the usage metering. The default is false, which means no dimension conversion and just use the origin dimension.

    partner Partner (string)

    Possible values: [``, ADYEN, ALIBABA, ANTHROPIC, AWS, AWS_CHINA, AZURE, CHARGEBEE, DATABRICKS, DOCUSIGN, DNS, GCP, GONG, GOOGLE, GITHUB, 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.

  • ]

  • joinOrganizationTime date-time
    lastUpdateTime date-time
    name string
    status string
    type OrganizationType (string)

    Possible values: [SELLER, BUYER, RESELLER]

    userEmail string
    userID string
    userName string

    The following fields are not included in the DB schema.

    userRole string
    website string
  • ]

Loading...