Read Sales Rep
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
<<subdomain>>variable will be replaced byapp.
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Path Parameters
The Chargify id of your seller account
The Advanced Billing id of sales rep.
Query Parameters
This parameter indicates if records should be fetched from live mode sites. Default value is true.
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.
1 <= value1This parameter indicates how many records to fetch in each request. Default value is 100.
100Header Parameters
Response Body
application/json
curl -X GET "https://example.com/sellers/string/sales_reps/string.json"{ "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 } ]}List Sales Reps GET
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](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`.
Retry Subscription PUT
Retries collecting the balance due on a past-due subscription without waiting for the next scheduled attempt. ## 3D Secure (3DS) Authentication post-authentication flow When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication. See the [3D Secure Post-Authentication Flow](https://docs.maxio.com/hc/en-us/articles/44277749524365-3D-Secure-Post-Authentication-Flow) article in the product documentation to learn how to manage the redirect flow.