update buyer

PATCH https://api.suger.cloud/org/{orgId}/buyer/{buyerId}

update buyer by the given organization and buyer id.

Parameters

Name	In	Type	Required	Description
`orgId`	path	string	yes	Organization ID
`buyerId`	path	string	yes	Buyer ID

Request Body

Required. Content-Type: application/json · Schema: UpdateBuyerParams

UpdateBuyerParams fields:

Field	Type	Required	Description
`chargebeeCustomerID`	string	no	The Chargebee Customer ID of the buyer. If not provided, the Chargebee Customer ID will not be updated.
`companyInfo`	CompanyInfo	no
`customerId`	string	no	The customer ID to recognize the cloud marketplace buyer in your internal system. This may be used for uploading CSV files for Batch Metering Usage
`description`	string	no	The description of the buyer. If not provided, the description will not be updated.
`lagoCustomerId`	string	no	The Lago Customer ID of the buyer. If not provided, the Lago Customer ID will not be updated.
`metronomeCustomerId`	string	no	The Metronome Customer ID of the buyer. If not provided, the Metronome Customer ID will not be updated.
`name`	string	no	The name of the buyer. If not provided, the name will not be updated.
`orbCustomerId`	string	no	The Orb Customer ID of the buyer. If not provided, the Orb Customer ID will not be updated.
`paymentConfig`	PaymentConfig	no
`quickbooksCustomerId`	string	no	The Quickbooks Customer ID of the buyer. If not provided, the Quickbooks Customer ID will not be updated.
`stripeCustomerId`	string	no	The Stripe Customer ID of the buyer. If not provided, the Stripe Customer ID will not be updated.

CompanyInfo fields:

Field	Type	Required	Description
`addressLine1`	string	no
`addressLine2`	string	no
`city`	string	no
`country`	string	no
`emailDomain`	string	no
`name`	string	no
`postalCode`	string	no
`state`	string	no
`validFrom`	string	no	When the company info becomes valid. in format "2006-01-02T15:04:05Z"

PaymentConfig fields:

Field	Type	Required	Description
`allowedWalletTypes`	array<BillingWalletType>	no	Allowed wallet types for this buyer, include payment methods from payment provider such as card, us_bank_account and credit.
`currency`	string	no	Currency used for billing.
`defaultWalletId`	string	no	Default wallet id which is a stripe payment method used to invoice.

Responses

200 — OK

Content-Type: application/json · Schema: IdentityBuyer

IdentityBuyer fields:

Field	Type	Required
`companyID`	string	no
`contactIds`	array<string>	no
`creationTime`	string	no
`description`	string	no
`externalID`	string	no
`id`	string	no
`info`	BuyerInfo	no
`lastUpdateTime`	string	no
`name`	string	no
`organizationID`	string	no
`partner`	Partner	no
`s3KeyLogo`	string	no
`tags`	array<string>	no

BuyerInfo fields:

Field	Type	Required	Description
`adyenBuyer`	AdyenBuyer	no
`awsBuyer`	AwsAccountIdentifier	no
`azureBuyer`	AzureADIdentifier	no
`chargebeeCustomerID`	string	no	ChargebeeCustomerID is the chargebee customer ID for ther buyer if it is connected to a chargebee customer.
`collectableAmount`	number	no	The amount that the seller can collect. It excludes the marketplace commision fee.
`companyInfo`	CompanyInfo	no
`cppoInOfferCount`	integer	no	The number of CPPO_IN offers related to the buyer.
`cppoOutOfferCount`	integer	no	The number of CPPO_OUT offers related to the buyer.
`customerId`	string	no	customerID of buyer on seller's side
`disbursedAmount`	number	no	The amount that has been disbursed to the seller account.
`emailAddress`	string	no	The email address of the buyer. This was copied from the new client signup form.
`enrichedCompanyInfo`	Company	no
`entitlementCount`	integer	no	The number of entitlements related to the buyer.
`fields`	object	no	Fields to store key-value pairs of buyer information.
`gcpBuyer`	GcpMarketplaceUserAccount	no
`grossAmount`	number	no	The gross amount that the buyer has committed to pay, including usage metered amount.
`invoicedAmount`	number	no	The amount that the buyer has got invoiced.
`lagoCustomerId`	string	no	The lgo customer ID for the buyer if it is connected to a lago customer.
`lastModifiedBy`	string	no	Last modifier user ID.
`metronomeCustomerId`	string	no	The metronome customer ID for the buyer if it is connected to a metronome customer.
`offerCount`	integer	no	The number of offers related to the buyer.
`oracleBuyer`	OracleMarketplaceBuyer	no
`orbCustomerId`	string	no	The orb customer ID for the buyer if it is connected to a orb customer.
`paymentConfig`	PaymentConfig	no
`quickbooksCustomerId`	string	no	The quickbooks customer ID for the buyer if it is connected to a quickbooks customer.
`snowflakeBuyer`	SnowflakeMarketplaceBuyer	no
`spaUrl`	string	no	Buyer SPA url, public page visited with jwt.
`stripeBuyer`	StripeCustomer	no
`stripeCustomerId`	string	no	The stripe customer ID for the buyer if it is connected to a stripe customer.

AdyenBuyer fields:

Field	Type	Required	Description
`settings`	object	no	Settings store key-value pairs such as paymentMethodId,syncWithProvider,providerPaymentMethods.
`shopperId`	string	no	The shopperId on the adyen platform corresponding to the buyer.

AwsAccountIdentifier fields:

Field	Type	Required	Description
`awsAccountID`	string	no	The AWS Account ID of the buyer in AWS Marketplace
`awsCustomerID`	string	no	The AWS Customer ID of the buyer in AWS Marketplace
`dataFeedAccountID`	string	no	The Account ID in AWS Marketplace Data Feed service

AzureADIdentifier fields:

Field	Type	Required	Description
`billingAccountId`	string	no	Azure Billing Account ID
`customerId`	string	no
`emailId`	string	no	Email address
`firstName`	string	no
`lastName`	string	no
`licenseType`	string	no	Azure License Type
`objectId`	string	no
`puid`	string	no	ID of the user, used as External ID of suger IdentityBuyer.
`sellerId`	string	no	Azure MPO seller ID
`tenantId`	string	no	The Azure Active Directory Tenant ID of the buyer or the reseller partner ID (the same as TenantId).

CompanyInfo fields:

Field	Type	Required	Description
`addressLine1`	string	no
`addressLine2`	string	no
`city`	string	no
`country`	string	no
`emailDomain`	string	no
`name`	string	no
`postalCode`	string	no
`state`	string	no
`validFrom`	string	no	When the company info becomes valid. in format "2006-01-02T15:04:05Z"

Company fields:

Field	Type	Required	Description
`city`	string	no
`contactEmail`	string	no	Contact
`country`	string	no	Location information
`creationTime`	string	no	Timestamps
`domain`	string	no
`employeeCount`	integer	no
`foundedYear`	string	no
`id`	string	no	Core identification fields
`industry`	string	no
`isVendor`	boolean	no	Vendor flag
`lastUpdateTime`	string	no
`linkedIn`	string	no	The link to the linkedin profile
`metaInfo`	CompanyMetaInfo	no
`name`	string	no	Basic company information
`partnerGlobalCompanyContactIds`	array<string>	no	Partner contacts associated with this buyer company (array of global_company_contact.id values)
`postalCode`	string	no
`s3KeyLogo`	string	no	Media and social
`shortDescription`	string	no
`stateProvince`	string	no
`status`	EnrichmentDataStatus	no
`street`	string	no
`type`	string	no	Private, Public, Nonprofit, Franchise
`website`	string	no

GcpMarketplaceUserAccount fields:

Field	Type	Required	Description
`approvals`	array<GcpMarketplaceUserAccountApproval>	no	The approvals for this account, that are permitted or have been completed.
`billingAccountId`	string	no	The buyer's GCP billing account ID if it's a company account.
`createTime`	string	no	RFC3339 UTC timestamp
`id`	string	no	GCP Marketplace User Account ID.
`inputProperties`	array<integer>	no
`name`	string	no	The resource name of the account, in format of providers/{provider_id}/accounts/{account_id}.
`parentBillingAccountId`	string	no	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	no	The identifier of the service provider (SaaS Seller) that this account was created against.
`state`	GcpMarketplaceUserAccountState	no
`updateTime`	string	no	RFC3339 UTC timestamp
`userInfo`	GcpUserInfo	no

OracleMarketplaceBuyer fields:

Field	Type	Required	Description
`companyName`	string	no	CompanyName is the buyer's company name.
`primaryContact`	OracleContact	no
`tenancyOCID`	string	no	TenancyOCID is the buyer's tenancy OCID (Offer.buyerCompartmentId).

PaymentConfig fields:

Field	Type	Required	Description
`allowedWalletTypes`	array<BillingWalletType>	no	Allowed wallet types for this buyer, include payment methods from payment provider such as card, us_bank_account and credit.
`currency`	string	no	Currency used for billing.
`defaultWalletId`	string	no	Default wallet id which is a stripe payment method used to invoice.

SnowflakeMarketplaceBuyer fields:

Field	Type	Required	Description
`snowflakeCustomerID`	string	no	The customer ID of the buyer in Snowflake Marketplace.

StripeCustomer fields:

Field	Type	Required	Description
`address`	StripeCustomerAddress	no
`description`	string	no
`email`	string	no
`id`	string	no	The customer ID on the stripe platform.
`metadata`	object	no	Set of key-value pairs that you can attach to store additional information about customer.
`name`	string	no
`phone`	string	no

500 — internal error

Content-Type: application/json

View as Markdown · Interactive API reference

Spotted something wrong or out of date on this page? Tell us and we'll correct it.