list buyers by partner
GET/org/:orgId/partner/:partner/buyer
list all buyers by the given organization and partner
Request
Path Parameters
Organization ID
Possible values: [AWS
, AZURE
, GCP
]
Cloud Partner
Query Parameters
List pagination size, default 1000, max value is 1000
List pagination offset, default 0
Responses
- 200
- 400
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
info
object
adyenBuyer
object
settings
object
Settings store key-value pairs such as paymentMethodId,syncWithProvider,providerPaymentMethods.
Settings store key-value pairs such as paymentMethodId,syncWithProvider,providerPaymentMethods.
The shopperId on the adyen platform corresponding to the buyer.
awsBuyer
object
The AWS Account ID of the buyer in AWS Marketplace
The AWS Customer ID of the buyer in AWS Marketplace
The Account ID in AWS Marketplace Data Feed service
azureBuyer
object
Azure Billing Account ID
Email address
Azure License Type
ID of the user, used as External ID of suger IdentityBuyer.
The amount that the seller can collect. It excludes the marketplace commision fee.
companyInfo
object
When the company info becomes valid. in format "2006-01-02T15:04:05Z"
customerID of buyer on seller's side
The amount that has been disbursed to the seller account.
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.
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.
An explanation for the state of the approval.
Possible values: [STATE_UNSPECIFIED
, PENDING
, APPROVED
, REJECTED
]
RFC3339 UTC timestamp
The buyer's GCP billing account ID.
RFC3339 UTC timestamp
GCP Marketplace User Account ID.
The resource name of the account. Account names have the form providers/{provider_id}/accounts/{account_id}.
The identifier of the service provider (SaaS Seller) that this account was created against.
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.
RFC3339 UTC timestamp
userInfo
object
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.
The user's obfuscated GAIA ID, which can be used to initiate Open ID Connect.
The gross amount that the buyer has committed to pay, including usage metered amount.
The amount that the buyer has got invoiced.
The lgo customer ID for the buyer if it is connected to a lago customer.
Last modifier user ID.
The metronome customer ID for the buyer if it is connected to a metronome customer.
The orb customer ID for the buyer if it is connected to a orb customer.
paymentConfig
object
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 used for billing.
Default wallet id which is a stripe payment method used to invoice.
Buyer SPA url, public page visited with jwt.
stripeBuyer
object
address
object
City, district, suburb, town, or village.
Two-letter country code (ISO 3166-1 alpha-2)
Address line 1 (e.g., street, PO Box, or company name).
Address line 2 (e.g., apartment, suite, unit, or building).
ZIP or postal code.
State, county, province, or region.
The customer ID on the stripe platform.
metadata
object
Set of key-value pairs that you can attach to store additional information about customer.
Possible values: [``, ADYEN
, ALIBABA
, AWS
, AWS_CHINA
, AZURE
, GCP
, GOOGLE
, HUBSPOT
, LAGO
, MARKETO
, METRONOME
, MICROSOFT
, ORACLE
, ORB
, REDHAT
, SALESFORCE
, SLACK
, STRIPE
, ZOHO
]
[
{
"contactIds": [
"string"
],
"creationTime": "2024-08-12T01:02:14.544Z",
"description": "string",
"externalID": "string",
"id": "string",
"info": {
"adyenBuyer": {
"settings": {},
"shopperId": "string"
},
"awsBuyer": {
"awsAccountID": "string",
"awsCustomerID": "string",
"dataFeedAccountID": "string"
},
"azureBuyer": {
"billingAccountId": "string",
"customerId": "string",
"emailId": "string",
"firstName": "string",
"lastName": "string",
"licenseType": "string",
"objectId": "string",
"puid": "string",
"tenantId": "string"
},
"collectableAmount": 0,
"companyInfo": {
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"country": "string",
"emailDomain": "string",
"name": "string",
"postalCode": "string",
"state": "string",
"validFrom": "string"
},
"customerId": "string",
"disbursedAmount": 0,
"emailAddress": "string",
"fields": {},
"gcpBuyer": {
"approvals": [
{
"name": "string",
"reason": "string",
"state": "STATE_UNSPECIFIED",
"updateTime": "string"
}
],
"billingAccountId": "string",
"createTime": "2024-08-12T01:02:14.545Z",
"id": "string",
"inputProperties": [
0
],
"name": "string",
"provider": "string",
"state": "ACCOUNT_STATE_UNSPECIFIED",
"updateTime": "2024-08-12T01:02:14.545Z",
"userInfo": {
"roles": [
"string"
],
"user_identity": "string"
}
},
"grossAmount": 0,
"invoicedAmount": 0,
"lagoCustomerId": "string",
"lastModifiedBy": "string",
"metronomeCustomerId": "string",
"orbCustomerId": "string",
"paymentConfig": {
"allowedWalletTypes": [
"ach_debit"
],
"currency": "string",
"defaultWalletId": "string"
},
"spaUrl": "string",
"stripeBuyer": {
"address": {
"city": "string",
"country": "string",
"line1": "string",
"line2": "string",
"postal_code": "string",
"state": "string"
},
"description": "string",
"email": "string",
"id": "string",
"metadata": {},
"name": "string",
"phone": "string"
}
},
"lastUpdateTime": "2024-08-12T01:02:14.545Z",
"name": "string",
"organizationID": "string",
"partner": ""
}
]
Bad request error
- application/json
- Schema
Schema
string
Internal server error
- application/json
- Schema
Schema
string