- Introduction
- Quickstart
- Webhooks
- Campaign
- Class
- Client
- Retrieves all client for a Tenant
- Creates a new client
- Gets client by ID
- Gets clients birthday list
- Gets clients at risk
- Gets client mandatory fields
- Adds client to blacklist
- Removes client from blacklist
- Updates client details
- Used for partial updates of client details
- Changes client representative
- Lists prospects
- Lists ex-clients
- Resets client password
- Changes client representative for multiple clients
- Lists prospect effective date history
- Transfers prospect
- Company
- Invoice
- Organisation
- Search
- Tax
- Tenant
- Appointments
- Create new appointment
- List appointments
- Change client membership in appointment
- Get appointment
- Update appointment
- Mark client as checked in
- Mark client as no-show
- Substitute coach for appointment
- Reschedule appointment
- Cancel appointment
- List appointments by client ID
- Create appointment complimentory session
- Create appointment
- Reschedule appointment
- Get appointment
- Appointment Types
- Authentication
- Automation
- Call Transactions
- Charge Categories
- Charge Master
- Recurring Class
- Class Booking
- Class Complimentory
- Class Types
- Company level class types
- Client Communication
- Client Tasks
- Client Sales
- Client Waivers
- Client Sessions
- Client Referrals
- Client Offers
- Client Export
- Client Billing
- Client Check-in
- Client Credit Balance
- Client Documents
- Client Invoices
- Client Membership
- Client Open API
- Client Payments
- Client Subscriptions
- List client subscription invoicesGET
- Get client subscriptionGET
- List client subscriptionsGET
- Get clients by plan IDGET
- Change subscription start datePUT
- Change subscription end datePUT
- Void client subscriptionPOST
- Send manage subscription linkPOST
- Get client subscription by UUIDGET
- Get client subscription invoices by UUIDGET
- Client Memberships
- Client Subscription Cancellation
- Client Subscription Freeze
- Client Trials
- Client Upgrade
- Balance Write Off
- Email Template
- Email Template - Franchise
- Create email template at franchise level
- Get list of email templates at franchise level
- Update email template at franchise level
- Get email template at franchise level
- Delete email template at franchise level
- Mark email template as inactive at franchise level
- Mark email template as active at franchise level
- Email Template - Tenant
- Franchise Groups
- Payment Methods
- Invoices
- Offer Master
- Online Signup
- Subscription
- Sales
- Staff Availability
- List staff availability
- List staff availability by appointment category
- List next available slots by appointment category
- Check staff availability
- Check staff availability for appointment category
- Check staff availability for recurring schedule
- Check staff availability for recurring schedule
- Get staff scheduled unavailability
- List staff availability for tours
- Opportunities
- Opportunity Stage Master
- Payments
- Refunds
- Reports
- Report Filter Schedules
- Access Requests
- Rooms
- Sales Returns
- Email Communication
- SMS
- Service Categories
- Staff Management
- Staff Appointment Type Link
- Staff Notifications
- Staff Schedule
- Subscription Plans
- Subscription Signup
- Tasks
- Task Categories
- Task Open API
- Trial Master
Get clients by plan ID
GET
/tenants/{tenant_id}/subscription_plans/{subscription_plan_id}/clients
Request
Path Params
Query Params
Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/tenants//subscription_plans//clients'Responses
🟢200OK
text/plain
Body
Example
{
"items": [
{
"clt_subs_id": 0,
"id": 0,
"full_name": "string",
"company_id": 0,
"tenant_id": 0,
"plan_id": 0,
"state": "InActive",
"status": "Future",
"name_primary_language": "string",
"name_secondary_language": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"next_charge_date": "2019-08-24T14:15:22Z",
"sign_up_date": "2019-08-24T14:15:22Z",
"recurring_template_recurring_services": [
{
"service_id": 0,
"service_category_id": 0,
"service_type_name_primary_language": "string",
"service_type_name_secondary_language": "string",
"service_sessions": 0,
"service_behaviour": "MemberShip",
"service_is_base_membership": true,
"service_session_owner_id": 0
}
],
"recurring_template_non_recurring_services": [
{
"service_id": 0,
"service_category_id": 0,
"service_type_name_primary_language": "string",
"service_type_name_secondary_language": "string",
"service_sessions": 0,
"service_behaviour": "MemberShip",
"service_is_base_membership": true,
"service_session_owner_id": 0
}
]
}
]
}Modified at 2025-03-21 07:23:14