Skip to main content

query buyers

GET 
/org/:orgId/buyer/query

Query buyers with advanced filtering, sorting, and pagination using CRUD query language. Supports complex filters, sorting by multiple fields, and pagination.

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., '(= partner \

    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 buyers

Schema

    data

    object[]

  • Array [

    • companyID string

    CompanyID holds the value of the "company_id" field.

    contactIds string[]

    ContactIds holds the value of the "contact_ids" field.

    creationTime date-time

    CreationTime holds the value of the "creation_time" field.

    description string

    Description holds the value of the "description" 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.

    adyenBuyer

    object

    Buyer on Adyen

    settings

    object

    Settings store key-value pairs such as paymentMethodId,syncWithProvider,providerPaymentMethods.

    property name* any

    Settings store key-value pairs such as paymentMethodId,syncWithProvider,providerPaymentMethods.

    shopperId string

    The shopperId on the adyen platform corresponding to the buyer.

    awsBuyer

    object

    Buyer from AWS Marketplace

    awsAccountID string

    The AWS Account ID of the buyer in AWS Marketplace

    awsCustomerID string

    The AWS Customer ID of the buyer in AWS Marketplace

    dataFeedAccountID string

    The Account ID in AWS Marketplace Data Feed service

    azureBuyer

    object

    Buyer from Azure Marketplace

    billingAccountId string

    Azure Billing Account ID

    customerId string
    emailId string

    Email address

    firstName string
    lastName string
    licenseType string

    Azure License Type

    objectId string
    puid string

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

    sellerId string

    Azure MPO seller ID

    tenantId string

    The Azure Active Directory Tenant ID of the buyer or the reseller partner ID (the same as TenantId).

    chargebeeCustomerID string

    ChargebeeCustomerID is the chargebee customer ID for ther buyer if it is connected to a chargebee customer.

    collectableAmount number

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

    companyInfo

    object

    Optional. CompanyInfo of the buyer.

    addressLine1 string
    addressLine2 string
    city string
    country string
    emailDomain string
    name string
    postalCode string
    state string
    validFrom string

    When the company info becomes valid. in format "2006-01-02T15:04:05Z"

    cppoInOfferCount integer

    The number of CPPO_IN offers related to the buyer.

    cppoOutOfferCount integer

    The number of CPPO_OUT offers related to the buyer.

    customerId string

    customerID of buyer on seller's side

    disbursedAmount number

    The amount that has been disbursed to the seller account.

    emailAddress string

    The email address of the buyer. This was copied from the new client signup form.

    enrichedCompanyInfo

    object

    These fields are only used in the buyer detail api response. The enriched company information from 3rd party services.

    city string
    contactEmail string

    Contact

    country string

    Location information

    creationTime date-time

    Timestamps

    domain string
    employeeCount integer
    foundedYear string
    id string

    Core identification fields

    industry string
    isVendor boolean

    Vendor flag

    lastUpdateTime date-time
    linkedIn string

    The link to the linkedin profile

    metaInfo

    object

    Additional information about the company populated by Suger, such as partner engagement scores

    awsEngagementScore string

    Partner engagement scores

    azureEngagementScore string

    Azure partner engagement score (High/Medium/Low)

    gcpEngagementScore string

    GCP partner engagement score (High/Medium/Low)

    name string

    Basic company information

    partnerGlobalCompanyContactIds string[]

    Partner contacts associated with this buyer company (array of global_company_contact.id values)

    postalCode string
    s3KeyLogo string

    Media and social

    shortDescription string
    stateProvince string
    status EnrichmentDataStatus (string)

    Possible values: [active, stale, archived]

    active/stale/archived

    street string
    type string

    Private, Public, Nonprofit, Franchise

    website string
    entitlementCount integer

    The number of entitlements related to the buyer.

    fields

    object

    Fields to store key-value pairs of buyer information.

    property name* any

    Fields to store key-value pairs of buyer information.

    gcpBuyer

    object

    Buyer from GCP Marketplace

    approvals

    object[]

    The approvals for this account, that are permitted or have been completed.

  • Array [

    • name string
    reason string

    An explanation for the state of the approval.

    state GcpMarketplaceUserAccountApprovalState (string)

    Possible values: [STATE_UNSPECIFIED, PENDING, APPROVED, REJECTED]

    updateTime string

    RFC3339 UTC timestamp

  • ]

    • billingAccountId string

    The buyer's GCP billing account ID if it's a company account.

    createTime date-time

    RFC3339 UTC timestamp

    id string

    GCP Marketplace User Account ID.

    inputProperties integer[]
    name string

    The resource name of the account, in format of providers/{provider_id}/accounts/{account_id}.

    parentBillingAccountId string

    The parent account ID of the BillingAccountId if the buyer is from a reseller in GCP Marketplace. It is the GCP billing account ID of the reseller in GCP Marketplace.

    provider string

    The identifier of the service provider (SaaS Seller) that this account was created against.

    state GcpMarketplaceUserAccountState (string)

    Possible values: [ACCOUNT_STATE_UNSPECIFIED, ACCOUNT_ACTIVE]

    The state of the account. An account might not be able to make a purchase if the billing account is suspended.

    updateTime date-time

    RFC3339 UTC timestamp

    userInfo

    object

    orders string[]

    a list of unique order IDs for each entitlement ID that indicates the different offers on the same product. This field is available only if multiple orders of the same product is enabled

    roles string[]

    An array of strings representing the user's roles. Right now, it can be either: ** account_admin, which indicates that the user is a Billing Account Administrator of the billing account that purchased the product, or ** project_editor, which indicates that the user is a Project Editor, but not a Billing Administrator, of the project under that billing account.

    user_identity string

    The user's obfuscated GAIA ID, which can be used to initiate Open ID Connect.

    grossAmount number

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

    invoicedAmount number

    The amount that the buyer has got invoiced.

    lagoCustomerId string

    The lgo customer ID for the buyer if it is connected to a lago customer.

    lastModifiedBy string

    Last modifier user ID.

    metronomeCustomerId string

    The metronome customer ID for the buyer if it is connected to a metronome customer.

    offerCount integer

    The number of offers related to the buyer.

    orbCustomerId string

    The orb customer ID for the buyer if it is connected to a orb customer.

    paymentConfig

    object

    Optional. PaymentConfig of the buyer. The currency can't be updated.

    allowedWalletTypes BillingWalletType (string)[]

    Possible values: [ach_debit, bacs_debit, card, credit, sepa_debit]

    Allowed wallet types for this buyer, include payment methods from payment provider such as card, us_bank_account and credit.

    currency string

    Currency used for billing.

    defaultWalletId string

    Default wallet id which is a stripe payment method used to invoice.

    quickbooksCustomerId string

    The quickbooks customer ID for the buyer if it is connected to a quickbooks customer.

    snowflakeBuyer

    object

    Buyer on Snowflake

    snowflakeCustomerID string

    The customer ID of the buyer in Snowflake Marketplace.

    spaUrl string

    Buyer SPA url, public page visited with jwt.

    stripeBuyer

    object

    Buyer as Customer on Stripe

    address

    object

    city string

    City, district, suburb, town, or village.

    country string

    Two-letter country code (ISO 3166-1 alpha-2)

    line1 string

    Address line 1 (e.g., street, PO Box, or company name).

    line2 string

    Address line 2 (e.g., apartment, suite, unit, or building).

    postal_code string

    ZIP or postal code.

    state string

    State, county, province, or region.

    description string
    email string
    id string

    The customer ID on the stripe platform.

    metadata

    object

    Set of key-value pairs that you can attach to store additional information about customer.

    property name* string
    name string
    phone string
    stripeCustomerId string

    The stripe customer ID for the buyer if it is connected to a stripe customer.

    lastUpdateTime date-time

    LastUpdateTime holds the value of the "last_update_time" field.

    name string

    Name holds the value of the "name" field.

    organizationID string

    OrganizationID holds the value of the "organization_id" field.

    partner string

    Partner holds the value of the "partner" field.

    s3KeyLogo string

    S3KeyLogo holds the value of the "s3_key_logo" field.

    tags string[]

    Tags holds the value of the "tags" field.

  • ]

    • page_number integer
    page_size integer
    total_count integer
Loading...