Maxio Advanced Billing
HomeSDKsAPI ReferenceContext Plugin
Sales Commissions

List Sales Reps

GET
/sellers/{seller_id}/sales_reps.json

Lists sales reps with details.

Modified Authentication Process

The Sales Commission API differs from other Chargify API endpoints. This resource is associated with the seller itself. Up to now all available resources were at the level of the site, therefore creating the API Key per site was a sufficient solution. To share resources at the seller level, a new authentication method was introduced, which is user authentication. Creating an API Key for a user is a required step to correctly use the Sales Commission API, more details here.

Access to the Sales Commission API endpoints is available to users with financial access, where the seller has the Advanced Analytics component enabled. For further information on getting access to Advanced Analytics contact Maxio support.

Note: The request is at seller level, it means <<subdomain>> variable will be replaced by app.

Authorization

BasicAuth
AuthorizationBasic <token>

The username is a Maxio Chargify API key. The password is x.

In: header

Path Parameters

seller_id*string

The Chargify id of your seller account

Query Parameters

live_mode?boolean

This parameter indicates if records should be fetched from live mode sites. Default value is true.

page?integer

Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned. Use in query page=1.

Range1 <= value
Default1
per_page?integer

This parameter indicates how many records to fetch in each request. Default value is 100.

Default100

Header Parameters

Authorization?string

For authorization use user API key. See details here.

Default"Bearer <<apiKey>>"

Response Body

application/json

curl -X GET "https://example.com/sellers/string/sales_reps.json"
[  {    "id": 48,    "full_name": "John Candy",    "subscriptions_count": 2,    "mrr_data": {      "november_2019": {        "mrr": "$0.00",        "usage": "$0.00",        "recurring": "$0.00"      },      "december_2019": {        "mrr": "$0.00",        "usage": "$0.00",        "recurring": "$0.00"      },      "january_2020": {        "mrr": "$400.00",        "usage": "$0.00",        "recurring": "$400.00"      },      "february_2020": {        "mrr": "$400.00",        "usage": "$0.00",        "recurring": "$400.00"      },      "march_2020": {        "mrr": "$400.00",        "usage": "$0.00",        "recurring": "$400.00"      },      "april_2020": {        "mrr": "$400.00",        "usage": "$0.00",        "recurring": "$400.00"      }    },    "test_mode": true  },  {    "id": 49,    "full_name": "Josh Acme",    "subscriptions_count": 1,    "mrr_data": {      "november_2019": {        "mrr": "$0.00",        "usage": "$0.00",        "recurring": "$0.00"      },      "december_2019": {        "mrr": "$0.00",        "usage": "$0.00",        "recurring": "$0.00"      },      "january_2020": {        "mrr": "$200.00",        "usage": "$0.00",        "recurring": "$200.00"      },      "february_2020": {        "mrr": "$200.00",        "usage": "$0.00",        "recurring": "$200.00"      },      "march_2020": {        "mrr": "$200.00",        "usage": "$0.00",        "recurring": "$200.00"      },      "april_2020": {        "mrr": "$200.00",        "usage": "$0.00",        "recurring": "$200.00"      }    },    "test_mode": true  }]

List Sales Commission Settings GET

Lists subscriptions with associated sales reps. ## Modified Authentication Process The Sales Commission API differs from other Chargify API endpoints. This resource is associated with the seller itself. Up to now all available resources were at the level of the site, therefore creating the API Key per site was a sufficient solution. To share resources at the seller level, a new authentication method was introduced, which is user authentication. Creating an API Key for a user is a required step to correctly use the Sales Commission API, more details [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api-authentication). Access to the Sales Commission API endpoints is available to users with financial access, where the seller has the Advanced Analytics component enabled. For further information on getting access to Advanced Analytics contact Maxio support. > Note: The request is at seller level, it means `<<subdomain>>` variable will be replaced by `app`.

Read Sales Rep GET

Returns a sales rep and attached subscription details. ## Modified Authentication Process The Sales Commission API differs from other Chargify API endpoints. This resource is associated with the seller itself. Up to now all available resources were at the level of the site, therefore creating the API Key per site was a sufficient solution. To share resources at the seller level, a new authentication method was introduced, which is user authentication. Creating an API Key for a user is a required step to correctly use the Sales Commission API, more details [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api-authentication). Access to the Sales Commission API endpoints is available to users with financial access, where the seller has the Advanced Analytics component enabled. For further information on getting access to Advanced Analytics contact Maxio support. > Note: The request is at seller level, it means `<<subdomain>>` variable will be replaced by `app`.