Introduction
The Account Fees API allows Private Market retailers to manage fee settings for their accounts through the external API. This includes retrieving fees for one or more accounts and updating those fees where permitted.Endpoints
Verb | Endpoint | Description |
|---|---|---|
POST |
| This endpoint allows users to retrieve fee settings for one or more accounts they have access to. |
POST |
| This endpoint allowsPrivate Market retailersto update fees for child seller or demand accounts. |
Search Account Fees
This endpoint allows users to retrieve fee settings for one or more accounts they have access to. You can find more details in the API reference for this endpoint here.Attributes
Attribute | Data Type | Description | Writeable | Nullable |
|---|---|---|---|---|
|
| Account ID Accepted values: string of Up to25 account IDscan be queried at once. | Y | N |
Optional Query Parameters
Query Parameters | Data Type | Description |
|---|---|---|
|
| Pagination parameter, seeAPI Response |
|
| Pagination parameter, seeAPI Response |
|
| Comma-separated list of optional attributes to include in the response. Used to optimize response time and payload length. |
Request Body
accountIdsis optional.accountIds: [""]→ returns an empty response.accountIds: []→ returns all accounts the user has consent to.- Up to 25 account IDs can be queried at once in the request.
- Must be sent as an array — not as a comma-separated string.
Example Response
Update Account Fees (retailers only)
This endpoint allows Private Market retailers to update fees for child seller or demand accounts. You can find more details about this endpoint in our API reference here. To use this endpoint, users must meet the following requirements:- OAuth Scope:
Account Manage - Consent:
- To the parent supply account
- To the child accounts for which fees are being managed
Attributes
Attribute | Data Type | Description | Writable | Nullable |
|---|---|---|---|---|
|
| Account ID Accepted values: string of | Y | N |
|
| Defines the set of fees you can set on the Account. Possible values:
| N | N |
|
| Value to apply as the Accepted range:0.00 to 1.00 Max precision:2 decimal places | Y | N |
|
| The managed service fee that is applied to the account. Options:
| N | N |
|
| Indicates if | Y | N |
|
| Indicates if | Y | N |
Feature flag
This functionality is available only to retailers who have the Private Market Fees setting enabled in their UI. If you do not see this feature in your account, please contact your support team or account representative. To have access to this functionality, retailers must:- Have access to the fee configuration UI,
- Enable either or both fee types:
- Managed Service Fee
- Demand Managed Fee
Request Body
Validation Rules
accountIdsis required — omitting it returns a 400 error.demandManaged.ratemust be a decimal between 0 and 1.managedService.onsiteDisplayEnabledandonsiteSponsoredProductsEnabledmust be boolean (trueorfalse).
Example Response
Responses
Response | Title |
|---|---|
🟢
| Success |
🔴
| Bad Request: Model Validation Error. Check that the acceptable values for the attributes are correct. |
🔴
| API user does not have the authorization to make requests to the account ID. For an authorization request, follow the authorization request steps . |