Skip to main content

list buyers

GET 
/org/:orgId/buyer

list buyers by the given organization with pagination and optional filters.

Request​

Path Parameters

    orgId stringrequired

    Organization ID

Query Parameters

    partner string

    filter by partner

    contactId string

    filter by contactId

    limit integer

    List pagination size, default 1000, max value is 1000

    offset integer

    List pagination offset, default 0

Responses​

OK

Schema

  • Array [

    • contactIds string[]
    creationTime date-time
    description string
    externalID string
    id string

    info

    object

    adyenBuyer

    object

    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

    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

    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.

    tenantId string
    collectableAmount number

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

    companyInfo

    object

    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"

    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.

    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

    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.

    createTime date-time

    RFC3339 UTC timestamp

    id string

    GCP Marketplace User Account ID.

    inputProperties integer[]
    name string

    The resource name of the account. Account names have the form providers/{provider_id}/accounts/{account_id}.

    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

    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.

    orbCustomerId string

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

    paymentConfig

    object

    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.

    spaUrl string

    Buyer SPA url, public page visited with jwt.

    stripeBuyer

    object

    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
    lastUpdateTime date-time
    name string
    organizationID string
    partner Partner (string)

    Possible values: [``, ADYEN, ALIBABA, AWS, AWS_CHINA, AZURE, GCP, GOOGLE, HUBSPOT, INTUIT, LAGO, MARKETO, METRONOME, MICROSOFT, ORACLE, ORB, REDHAT, SALESFORCE, SLACK, STRIPE, ZOHO]

  • ]

Loading...