Sales Commissions allow sellers with financial access to retrieve commission data for a site with Advanced Analytics enabled. These endpoints use a different, user-level authentication method than the rest of the API, since commission data is tied to the seller rather than an individual site.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/maxio:maxio-sales-commissions-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Maxio Sales Commissions API
version: '1.0'
contact:
email: support@maxio.com
description: 'Operations tagged Sales Commissions across 2 of this provider''s published API definitions: maxio-advanced-billing-openapi31json.json, maxio-advanced-billing-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{site}.chargify.com
description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://events.chargify.com/{site}
description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://{site}.ebilling.maxio.com
description: Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
security:
- BasicAuth: []
tags:
- name: Sales Commissions
description: 'Sales Commissions allow sellers with financial access to retrieve commission data for a site with Advanced Analytics enabled.
These endpoints use a different, user-level authentication method than the rest of the API, since commission data is tied to the seller rather than an individual site.'
paths:
/sellers/{seller_id}/sales_commission_settings.json:
parameters: []
get:
tags:
- Sales Commissions
summary: listSalesCommissionSettings
description: '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.
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 `>` variable will be replaced by `app`.'
operationId: listSalesCommissionSettings
parameters:
- name: seller_id
in: path
description: The Chargify id of your seller account
required: true
schema:
type: string
- name: Authorization
in: header
description: For authorization use user API key. See details [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api-authentication).
schema:
type: string
default: Bearer <<apiKey>>
- name: live_mode
in: query
description: This parameter indicates if records should be fetched from live mode sites. Default value is true.
style: form
explode: true
schema:
type: boolean
- name: page
in: query
description: '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`.'
style: form
explode: true
schema:
minimum: 1.0
type: integer
contentEncoding: int32
default: 1
examples:
- 1
- name: per_page
in: query
description: This parameter indicates how many records to fetch in each request. Default value is 100.
style: form
explode: true
schema:
type: integer
contentEncoding: int32
default: 100
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SaleRepSettings'
description: ''
examples:
- - customer_name: Ziomek Ziomeczek
subscription_id: 81746
site_link: https://chargify9.staging-chargify.com/dashboard
site_name: Chargify
subscription_mrr: $200.00
sales_rep_id: 48
sales_rep_name: John Candy
- customer_name: Ziom Kom
subscription_id: 83758
site_link: https://chargify9.staging-chargify.com/dashboard
site_name: Chargify
subscription_mrr: $200.00
sales_rep_id: 49
sales_rep_name: Josh Acme
- customer_name: George Bush
subscription_id: 83790
site_link: https://chargify9.staging-chargify.com/dashboard
site_name: Chargify
subscription_mrr: $200.00
sales_rep_id: 48
sales_rep_name: John Candy
contentMediaType: application/json
examples:
Example:
value:
- customer_name: Ziomek Ziomeczek
subscription_id: 81746
site_link: https://chargify9.staging-chargify.com/dashboard
site_name: Chargify
subscription_mrr: $200.00
sales_rep_id: 48
sales_rep_name: John Candy
- customer_name: Ziom Kom
subscription_id: 83758
site_link: https://chargify9.staging-chargify.com/dashboard
site_name: Chargify
subscription_mrr: $200.00
sales_rep_id: 49
sales_rep_name: Josh Acme
- customer_name: George Bush
subscription_id: 83790
site_link: https://chargify9.staging-chargify.com/dashboard
site_name: Chargify
subscription_mrr: $200.00
sales_rep_id: 48
sales_rep_name: John Candy
deprecated: false
servers:
- url: https://{site}.chargify.com
description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://events.chargify.com/{site}
description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://{site}.ebilling.maxio.com
description: Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://events.chargify.com/{site}
description: Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
/sellers/{seller_id}/sales_reps.json:
parameters: []
get:
tags:
- Sales Commissions
summary: listSalesReps
description: '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 `>` variable will be replaced by `app`.'
operationId: listSalesReps
parameters:
- name: seller_id
in: path
description: The Chargify id of your seller account
required: true
schema:
type: string
- name: Authorization
in: header
description: For authorization use user API key. See details [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api-authentication).
schema:
type: string
default: Bearer <<apiKey>>
- name: live_mode
in: query
description: This parameter indicates if records should be fetched from live mode sites. Default value is true.
style: form
explode: true
schema:
type: boolean
- name: page
in: query
description: '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`.'
style: form
explode: true
schema:
minimum: 1.0
type: integer
contentEncoding: int32
default: 1
examples:
- 1
- name: per_page
in: query
description: This parameter indicates how many records to fetch in each request. Default value is 100.
style: form
explode: true
schema:
type: integer
contentEncoding: int32
default: 100
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ListSaleRepItem'
description: ''
examples:
- - 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
contentMediaType: application/json
examples:
Example:
value:
- 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
deprecated: false
servers:
- url: https://{site}.chargify.com
description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://events.chargify.com/{site}
description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://{site}.ebilling.maxio.com
description: Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://events.chargify.com/{site}
description: Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
/sellers/{seller_id}/sales_reps/{sales_rep_id}.json:
parameters: []
get:
tags:
- Sales Commissions
summary: readSalesRep
description: '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.
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 `>` variable will be replaced by `app`.'
operationId: readSalesRep
parameters:
- name: seller_id
in: path
description: The Chargify id of your seller account
required: true
schema:
type: string
- name: sales_rep_id
in: path
description: The Advanced Billing id of sales rep.
required: true
schema:
type: string
- name: Authorization
in: header
description: For authorization use user API key. See details [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api-authentication).
schema:
type: string
default: Bearer <<apiKey>>
- name: live_mode
in: query
description: This parameter indicates if records should be fetched from live mode sites. Default value is true.
style: form
explode: true
schema:
type: boolean
- name: page
in: query
description: '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`.'
style: form
explode: true
schema:
minimum: 1.0
type: integer
contentEncoding: int32
default: 1
examples:
- 1
- name: per_page
in: query
description: This parameter indicates how many records to fetch in each request. Default value is 100.
style: form
explode: true
schema:
type: integer
contentEncoding: int32
default: 100
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SaleRep'
- examples:
- id: 48
full_name: John Candy
subscriptions_count: 2
test_mode: true
subscriptions:
- id: 81746
site_name: Chargify
subscription_url: https://chargify9.staging-chargify.com/subscriptions/81746
customer_name: Ziomek Ziomeczek
created_at: '2020-01-03T02:36:27-05:00'
mrr: $200.00
usage: $0.00
recurring: $200.00
last_payment: '2020-04-03T03:40:27-04:00'
churn_date: null
- id: 83790
site_name: Chargify
subscription_url: https://chargify9.staging-chargify.com/subscriptions/83790
customer_name: George Bush
created_at: '2020-01-17T07:34:32-05:00'
mrr: $200.00
usage: $0.00
recurring: $200.00
last_payment: '2020-04-17T08:41:03-04:00'
churn_date: null
contentMediaType: application/json
examples:
Example:
value:
id: 48
full_name: John Candy
subscriptions_count: 2
test_mode: true
subscriptions:
- id: 81746
site_name: Chargify
subscription_url: https://chargify9.staging-chargify.com/subscriptions/81746
customer_name: Ziomek Ziomeczek
created_at: '2020-01-03T02:36:27-05:00'
mrr: $200.00
usage: $0.00
recurring: $200.00
last_payment: '2020-04-03T03:40:27-04:00'
churn_date: null
- id: 83790
site_name: Chargify
subscription_url: https://chargify9.staging-chargify.com/subscriptions/83790
customer_name: George Bush
created_at: '2020-01-17T07:34:32-05:00'
mrr: $200.00
usage: $0.00
recurring: $200.00
last_payment: '2020-04-17T08:41:03-04:00'
churn_date: null
deprecated: false
servers:
- url: https://{site}.chargify.com
description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://events.chargify.com/{site}
description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://{site}.ebilling.maxio.com
description: Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://events.chargify.com/{site}
description: Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
components:
schemas:
SaleRep:
title: SaleRep
type: object
properties:
id:
type: integer
contentEncoding: int32
full_name:
type: string
subscriptions_count:
type: integer
contentEncoding: int32
test_mode:
type: boolean
subscriptions:
type: array
items:
$ref: '#/components/schemas/SaleRepSubscription'
description: ''
SaleRepItemMrr:
title: SaleRepItemMrr
type: object
properties:
mrr:
type: string
usage:
type: string
recurring:
type: string
ListSaleRepItem:
title: ListSaleRepItem
type: object
properties:
id:
type: integer
contentEncoding: int32
full_name:
type: string
subscriptions_count:
type: integer
contentEncoding: int32
mrr_data:
type: object
additionalProperties:
$ref: '#/components/schemas/SaleRepItemMrr'
examples:
- 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
test_mode:
type: boolean
SaleRepSettings:
title: SaleRepSettings
type: object
properties:
customer_name:
type: string
subscription_id:
type: integer
contentEncoding: int32
site_link:
type: string
site_name:
type: string
subscription_mrr:
type: string
sales_rep_id:
type: integer
contentEncoding: int32
sales_rep_name:
type: string
SaleRepSubscription:
title: SaleRepSubscription
type: object
properties:
id:
type: integer
contentEncoding: int32
site_name:
type: string
subscription_url:
type: string
customer_name:
type: string
created_at:
type: string
mrr:
type: string
usage:
type: string
recurring:
type: string
last_payment:
type: string
churn_date:
type:
- string
- 'null'
securitySchemes:
BasicAuth:
type: http
description: The `username` is a Maxio Chargify API key. The `password` is `x`.
scheme: basic
x-refined-from:
- maxio-advanced-billing-openapi31json.json
- maxio-advanced-billing-openapi.yml
x-provenance:
method: harvested
publisher: Maxio
source: https://developers.maxio.com/static/exports/maxio-advanced-billing-openapi31json.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)