- 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 client subscription
GET
/clients/{client_id}/subscriptions/{clt_subs_id}
Client Subscriptions
Request
Path Params
client_id
integer <int64>
required
clt_subs_id
integer <int32>
required
Request 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 '/clients//subscriptions/'
Responses
🟢200OK
text/plain
Body
id
integer <int32>
optional
client_id
integer <int64>
optional
company_id
integer <int32> | nullÂ
optional
tenant_id
integer <int32> | nullÂ
optional
company_uuid
string  | nullÂ
optional
tenant_uuid
string  | nullÂ
optional
plan_id
integer <int32>
optional
state
enum<string>Â
optional
InActive
-Active
-Allowed values:
InActiveActive
status
enum<string>Â
optional
Future
-Active
-Frozen
-SuspendedDueToNonPayment
-Upgraded
-Transfered
-NotRenewing
-Cancelled
-CancelledDueToNonPayment
-PendingForMandatoryAction
-PendingForPaymentConfirmation
-Expired
-Void
-Allowed values:
FutureActiveFrozenSuspendedDueToNonPaymentUpgradedTransferedNotRenewingCancelledCancelledDueToNonPaymentPendingForMandatoryActionPendingForPaymentConfirmationExpiredVoid
scheduled_cancellation_date
string <date-time>
optional
name_primary_language
string  | nullÂ
optional
name_secondary_language
string  | nullÂ
optional
description_primary_language
string  | nullÂ
optional
description_secondary_language
string  | nullÂ
optional
subscription_category
enum<string>Â
optional
PayAsYouGo
- Pay as you goPaidInFull
- Paid In fullDropIn
- Drop InContract
- ContractAllowed values:
PayAsYouGoPaidInFullDropInContract
billing_interval_type
enum<string>Â
optional
Day
-Week
-Month
-Allowed values:
DayWeekMonth
billing_interval_value
integer <int32>
optional
bill_cycle_day
integer <int32>
optional
contract_term
integer <int32>
optional
minimum_contract_commitment
integer <int32>
optional
minimum_contract_commitment_end_date
string <date-time>
optional
is_autopay_enabled
booleanÂ
optional
payment_primary_token_id
integer <int64>
optional
payment_Secondary_token_id
integer <int64>
optional
start_date
string <date-time>
optional
end_date
string <date-time>
optional
next_charge_date
string <date-time>
optional
recurring_revenue
integer <int64>
optional
feature_is_early_cancellation_allowed
booleanÂ
optional
early_cancellation_charge_master_id
integer <int32>
optional
feature_is_online_termination_allowed
booleanÂ
optional
auto_apply_deposit_end_min_commitment
booleanÂ
optional
number_of_occurance_as_deposit
integer <int32>
optional
freeze_type
enum<string>Â
optional
NoFreeze
-FreeFreeze
-PaidFreeze
-Allowed values:
NoFreezeFreeFreezePaidFreeze
freeze_allowed_number_of_attempts_in_year
integer <int32>
optional
freeze_can_only_billing_cycle
booleanÂ
optional
freeze_fee_per_instance_charge_master_id
integer <int32>
optional
freeze_maximum_days_per_instance
integer <int32>
optional
transferable
booleanÂ
optional
minimum_days_required_for_transfer
integer <int32>
optional
is_early_cancel
booleanÂ
optional
feature_is_cash_recurring
booleanÂ
optional
signup_invoice_id
integer <int64>
optional
track_mode
enum<string>Â
optional
StaffWebApp
-StaffMobileApp
-ClientMobileApp
-ClientPurchasePortal
-ClientWebsiteWidget
-FFMavrick
-ClientWebSignup
-FFHangfireJob
-Widget
-Allowed values:
StaffWebAppStaffMobileAppClientMobileAppClientPurchasePortalClientWebsiteWidgetFFMavrickClientWebSignupFFHangfireJobWidget
recurring_template_recurring_services
array[object (ListRecurringTemplateRecurringServicesResponse) {24}]  | nullÂ
optional
client_membership_id
integer <int32>
optional
service_id
integer <int32>
optional
service_category_id
integer <int32>
optional
service_base_cost_in_minor_currency
integer <int64>
optional
service_sessions
integer <int32>
optional
service_sessions_booked
integer <int32>
optional
service_sessions_used
integer <int32>
optional
service_sessions_noshow
integer <int32>
optional
available_sessions
integer <int32>
optional
service_category_name_primary_language
string  | nullÂ
optional
service_category_name_secondary_language
string  | nullÂ
optional
service_category_description_primary_language
string  | nullÂ
optional
service_category_description_secondary_language
string  | nullÂ
optional
service_behaviour
enum<string>Â
optional
MemberShip
-AppointmentPackage
-ClassPackage
-Allowed values:
MemberShipAppointmentPackageClassPackage
service_tax_item_code
string  | nullÂ
optional
service_is_base_membership
booleanÂ
optional
service_require_base_membership
booleanÂ
optional
service_is_session_owner_required
booleanÂ
optional
service_session_owner_id
integer <int32>
optional
service_category_icon
string  | nullÂ
optional
taxgrp_id
integer <int32>
optional
tax_group_name_primary_language
string  | nullÂ
optional
tax_group_name_secondary_language
string  | nullÂ
optional
discount_reason
string  | nullÂ
optional
recurring_template_non_recurring_services
array[object (ListRecurringTemplateNonRecurringServicesResponse) {28}]  | nullÂ
optional
client_membership_id
integer <int32>
optional
service_id
integer <int32>
optional
service_category_id
integer <int32>
optional
service_base_cost_in_minor_currency
integer <int64>
optional
service_sessions
integer <int32>
optional
service_sessions_booked
integer <int32>
optional
service_sessions_used
integer <int32>
optional
service_sessions_noshow
integer <int32>
optional
available_sessions
integer <int32>
optional
service_category_name_primary_language
string  | nullÂ
optional
service_category_name_secondary_language
string  | nullÂ
optional
service_category_description_primary_language
string  | nullÂ
optional
service_category_description_secondary_language
string  | nullÂ
optional
service_behaviour
enum<string>Â
optional
MemberShip
-AppointmentPackage
-ClassPackage
-Allowed values:
MemberShipAppointmentPackageClassPackage
service_tax_item_code
string  | nullÂ
optional
service_is_base_membership
booleanÂ
optional
service_require_base_membership
booleanÂ
optional
service_is_session_owner_required
booleanÂ
optional
service_session_owner_id
integer <int32>
optional
service_category_icon
string  | nullÂ
optional
service_interval_type
string  | nullÂ
optional
service_interval_value
string  | nullÂ
optional
service_start_date
string <date-time>
optional
service_end_date
string <date-time>
optional
taxgrp_id
integer <int32>
optional
tax_group_name_primary_language
string  | nullÂ
optional
tax_group_name_secondary_language
string  | nullÂ
optional
discount_reason
string  | nullÂ
optional
primary_payment_method
object (GetClientPaymentTokenResponse)Â
optional
id
integer <int64>
optional
level1
enum<string>Â
optional
Cash
-Card
-NetBanking
-UPI
-Wallet
-ACH
-Cheque
-Other
-Emandate
-Adjustment
-PayTo
-Allowed values:
CashCardNetBankingUPIWalletACHChequeOtherEmandateAdjustmentPayTo
level2
enum<string>Â
optional
Cash
-Debit
-Credit
-Emandate
-UPI
-Paytm
-AmazonPay
-Venmo
-ACH
-Cheque
-Sodexo
-NetBanking
-ApplePay
-CareemPay
-Knet
-OmanPay
-Fawry
-Benefit
-Mada
-Tabby
-Transfer
-PayTo
-Card
-GCash
-GooglePay
-Link
-Allowed values:
CashDebitCreditEmandateUPIPaytmAmazonPayVenmoACHChequeSodexoNetBankingApplePayCareemPayKnetOmanPayFawryBenefitMadaTabbyTransferPayToCardGCashGooglePayLink
network_type
string  | nullÂ
optional
masked_card_number
string  | nullÂ
optional
masked_account_number
string  | nullÂ
optional
upi_provider
string  | nullÂ
optional
vpa_id
string  | nullÂ
optional
expiry_date
string <date-time> | nullÂ
optional
token_status
enum<string>Â
optional
iniitiated
-confirmed
-rejected
-cancelled
-paused
-Allowed values:
iniitiatedconfirmedrejectedcancelledpaused
bank_name
string  | nullÂ
optional
pay_to_details
string  | nullÂ
optional
token_account_holder_name
string  | nullÂ
optional
token_alias_type
string  | nullÂ
optional
token_alias_type_id
string  | nullÂ
optional
token_account_type
string  | nullÂ
optional
is_apple_pay_or_google_pay
booleanÂ
optional
secondary_payment_method
object (GetClientPaymentTokenResponse)Â
optional
recurring_template_subscription_tax_calculation_method
enum<string>Â
optional
Inclusive
-Exclusive
-Allowed values:
InclusiveExclusive
suspended_date
string <date-time>
optional
suspended_by
integer <int32>
optional
suspended_reason
string  | nullÂ
optional
created_by
integer <int32>
optional
created_date
string <date-time>
optional
updated_by
integer <int32>
optional
updated_date
string <date-time>
optional
cancelled_by
integer <int32>
optional
cancelled_date
string <date-time>
optional
cancel_reason
string  | nullÂ
optional
sign_up_date
string <date-time>
optional
on_contract_expiry
enum<string>Â
optional
ContractExpire
-ContractAutoRenew
-ContractConvertsToPayAsYouGo
-Allowed values:
ContractExpireContractAutoRenewContractConvertsToPayAsYouGo
billing_interval_completed
number <double>
optional
freeze_fee
object (GetChargeMasterByClientSubscription)Â
optional
id
integer <int32>
optional
name_primary_language
string  | nullÂ
optional
name_secondary_language
string  | nullÂ
optional
amount_in_minor_currency
integer <int64>
optional
cancel_fee
object (GetChargeMasterByClientSubscription)Â
optional
total_amount_minor_currency
integer <int64>
optional
upgrade_allowed_days
integer <int32>
optional
upgrade_from_clt_subs_id
integer <int64>
optional
upgrade_to_clt_subs_id
integer <int64>
optional
access_tenant_in
string  | nullÂ
optional
subscription_deposit
array[object (SubscriptionDepositResponse) {4}]  | nullÂ
optional
occurence_to_apply
integer <int32>
optional
occurence_type
enum<string>Â
optional
None
-AutoApplyOnOccurence
-AutoApplyBeforeCancellation
-ApplyManually
-Allowed values:
NoneAutoApplyOnOccurenceAutoApplyBeforeCancellationApplyManually
occurence_amount_in_minor_currency
integer <int64>
optional
is_deposit_apply
booleanÂ
optional
is_presale
booleanÂ
optional
allow_cross_tenant_access
booleanÂ
optional
Example
{
"id": 0,
"client_id": 0,
"company_id": 0,
"tenant_id": 0,
"company_uuid": "string",
"tenant_uuid": "string",
"plan_id": 0,
"state": "InActive",
"status": "Future",
"scheduled_cancellation_date": "2019-08-24T14:15:22Z",
"name_primary_language": "string",
"name_secondary_language": "string",
"description_primary_language": "string",
"description_secondary_language": "string",
"subscription_category": "PayAsYouGo",
"billing_interval_type": "Day",
"billing_interval_value": 0,
"bill_cycle_day": 0,
"contract_term": 0,
"minimum_contract_commitment": 0,
"minimum_contract_commitment_end_date": "2019-08-24T14:15:22Z",
"is_autopay_enabled": true,
"payment_primary_token_id": 0,
"payment_Secondary_token_id": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"next_charge_date": "2019-08-24T14:15:22Z",
"recurring_revenue": 0,
"feature_is_early_cancellation_allowed": true,
"early_cancellation_charge_master_id": 0,
"feature_is_online_termination_allowed": true,
"auto_apply_deposit_end_min_commitment": true,
"number_of_occurance_as_deposit": 0,
"freeze_type": "NoFreeze",
"freeze_allowed_number_of_attempts_in_year": 0,
"freeze_can_only_billing_cycle": true,
"freeze_fee_per_instance_charge_master_id": 0,
"freeze_maximum_days_per_instance": 0,
"transferable": true,
"minimum_days_required_for_transfer": 0,
"is_early_cancel": true,
"feature_is_cash_recurring": true,
"signup_invoice_id": 0,
"track_mode": "StaffWebApp",
"recurring_template_recurring_services": [
{
"client_membership_id": 0,
"service_id": 0,
"service_category_id": 0,
"service_base_cost_in_minor_currency": 0,
"service_sessions": 0,
"service_sessions_booked": 0,
"service_sessions_used": 0,
"service_sessions_noshow": 0,
"available_sessions": 0,
"service_category_name_primary_language": "string",
"service_category_name_secondary_language": "string",
"service_category_description_primary_language": "string",
"service_category_description_secondary_language": "string",
"service_behaviour": "MemberShip",
"service_tax_item_code": "string",
"service_is_base_membership": true,
"service_require_base_membership": true,
"service_is_session_owner_required": true,
"service_session_owner_id": 0,
"service_category_icon": "string",
"taxgrp_id": 0,
"tax_group_name_primary_language": "string",
"tax_group_name_secondary_language": "string",
"discount_reason": "string"
}
],
"recurring_template_non_recurring_services": [
{
"client_membership_id": 0,
"service_id": 0,
"service_category_id": 0,
"service_base_cost_in_minor_currency": 0,
"service_sessions": 0,
"service_sessions_booked": 0,
"service_sessions_used": 0,
"service_sessions_noshow": 0,
"available_sessions": 0,
"service_category_name_primary_language": "string",
"service_category_name_secondary_language": "string",
"service_category_description_primary_language": "string",
"service_category_description_secondary_language": "string",
"service_behaviour": "MemberShip",
"service_tax_item_code": "string",
"service_is_base_membership": true,
"service_require_base_membership": true,
"service_is_session_owner_required": true,
"service_session_owner_id": 0,
"service_category_icon": "string",
"service_interval_type": "string",
"service_interval_value": "string",
"service_start_date": "2019-08-24T14:15:22Z",
"service_end_date": "2019-08-24T14:15:22Z",
"taxgrp_id": 0,
"tax_group_name_primary_language": "string",
"tax_group_name_secondary_language": "string",
"discount_reason": "string"
}
],
"primary_payment_method": {
"id": 0,
"level1": "Cash",
"level2": "Cash",
"network_type": "string",
"masked_card_number": "string",
"masked_account_number": "string",
"upi_provider": "string",
"vpa_id": "string",
"expiry_date": "2019-08-24T14:15:22Z",
"token_status": "iniitiated",
"bank_name": "string",
"pay_to_details": "string",
"token_account_holder_name": "string",
"token_alias_type": "string",
"token_alias_type_id": "string",
"token_account_type": "string",
"is_apple_pay_or_google_pay": true
},
"secondary_payment_method": {
"id": 0,
"level1": "Cash",
"level2": "Cash",
"network_type": "string",
"masked_card_number": "string",
"masked_account_number": "string",
"upi_provider": "string",
"vpa_id": "string",
"expiry_date": "2019-08-24T14:15:22Z",
"token_status": "iniitiated",
"bank_name": "string",
"pay_to_details": "string",
"token_account_holder_name": "string",
"token_alias_type": "string",
"token_alias_type_id": "string",
"token_account_type": "string",
"is_apple_pay_or_google_pay": true
},
"recurring_template_subscription_tax_calculation_method": "Inclusive",
"suspended_date": "2019-08-24T14:15:22Z",
"suspended_by": 0,
"suspended_reason": "string",
"created_by": 0,
"created_date": "2019-08-24T14:15:22Z",
"updated_by": 0,
"updated_date": "2019-08-24T14:15:22Z",
"cancelled_by": 0,
"cancelled_date": "2019-08-24T14:15:22Z",
"cancel_reason": "string",
"sign_up_date": "2019-08-24T14:15:22Z",
"on_contract_expiry": "ContractExpire",
"billing_interval_completed": 0,
"freeze_fee": {
"id": 0,
"name_primary_language": "string",
"name_secondary_language": "string",
"amount_in_minor_currency": 0
},
"cancel_fee": {
"id": 0,
"name_primary_language": "string",
"name_secondary_language": "string",
"amount_in_minor_currency": 0
},
"total_amount_minor_currency": 0,
"upgrade_allowed_days": 0,
"upgrade_from_clt_subs_id": 0,
"upgrade_to_clt_subs_id": 0,
"access_tenant_in": "string",
"subscription_deposit": [
{
"occurence_to_apply": 0,
"occurence_type": "None",
"occurence_amount_in_minor_currency": 0,
"is_deposit_apply": true
}
],
"is_presale": true,
"allow_cross_tenant_access": true
}
Modified at 2025-03-21 07:23:14