v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB

Commission Schedules

List Commission Schedules

Retrieves a list of Commissions Schedules by accountID.

get/accounts/{accountID}/commissions

Path parameters

accountIDstring required

The user's unique account identifier.

Example:cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407775317759

Response

Retrieving a list of Commissions Schedules was Successful.

activeboolean

Commission group status.

commissionIDstring

The unique identifier associated with a specific commission related to the account.

descriptionstring

A short description about the commission.

Example response

[
  {
    "active": true,
    "commissionID": "b3e985dd-9679-63dc-5dd5-9bd7982efecd",
    "description": "Free",
    "assignmentCriteria": {
      "wplID": "TTC",
      "countries": "USA",
      "defaultStatus": true
    },
    "rates": {
      "fractional": {
        "schema": {
          "rate": 1.49,
          "passThroughFees": true,
          "shareAmountRounding": "CEIL",
          "minimumRate": 1.49
        }
      },
      "default": {
        "schema": {
          "rate": 1.49,
          "passThroughFees": true,
          "shareAmountRounding": "CEIL",
          "minimumRate": 1.49
        }
      }
    }
  }
]