FitnessForce - UFP
Home
Home
  1. Client Payments
  • Introduction
  • Quickstart
  • Webhooks
  • Campaign
    • Get campaign
      GET
    • List campaign
      GET
    • Get campaign by GUID
      GET
    • Get automation by franchise
      GET
    • Get automation by tenant
      GET
    • Get automation by company
      GET
    • Update automation active
      POST
    • Update automation inactive
      POST
    • Update campaign active
      POST
    • Update campaign inactive
      POST
  • Class
    • Get class by id
      GET
    • Delete class
      DELETE
    • Update class
      PUT
    • List classes
      GET
    • Create class
      POST
    • Substitute coach in class
      POST
    • Reschedule class
      POST
    • Cancel class
      POST
    • Mark class as completed
      POST
    • List class bookings by client id
      GET
  • Client
    • Retrieves all client for a Tenant
      GET
    • Creates a new client
      POST
    • Gets client by ID
      GET
    • Gets clients birthday list
      GET
    • Gets clients at risk
      GET
    • Gets client mandatory fields
      GET
    • Adds client to blacklist
      POST
    • Removes client from blacklist
      POST
    • Updates client details
      PUT
    • Used for partial updates of client details
      PATCH
    • Changes client representative
      POST
    • Lists prospects
      GET
    • Lists ex-clients
      GET
    • Resets client password
      POST
    • Changes client representative for multiple clients
      POST
    • Lists prospect effective date history
      GET
    • Transfers prospect
      POST
  • Company
    • Get company details
  • Invoice
    • Get invoice PDF
  • Organisation
    • List organisations
    • Get organisation
  • Search
    • Perform Client Search
    • Search clients by tenant
    • Search clients by provider
    • Search clients by company
  • Tax
    • Get Tax Groups
    • Get Tax Group by ID
    • Get Tax Groups by Tenant IDs
    • Get Tax Line Items
    • Get Tax Line Item by ID
    • List Tax Line Items
    • List Tax Line Types
  • Tenant
    • Get tenant details
    • List tenants
    • Gets list of tenants
    • Updates tenant details
    • Gets tenant details
    • Updates tenant invoice template type
    • Updates tenant payment template type
  • 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
    • Get appointment types list
    • Get appointment type details
  • Authentication
    • Refresh Token exchange
    • Generate authentication token
  • Automation
    • Get automation master
    • List automation types
  • Call Transactions
    • Get call transaction details
    • Log new call transaction
    • Update call transaction
    • Delete call transaction
  • Charge Categories
    • List charge categories
    • Get charge category
  • Charge Master
    • List charge masters
    • Get charge master
    • Calculate charge breakup
  • Recurring Class
    • Create recurring class
    • List recurring class template
    • Update recurring class
    • Get recurring class template
    • Cancel recurring class
    • Reschedule recurring class
    • Substitute coach in recurring class
    • List classes by recurring class template ID
  • Class Booking
    • Books client to class
    • Changes client membership
    • Removes client from class
    • Marks client as no-show
    • Marks client as checked in
    • Adds a trial client to class
  • Class Complimentory
    • Creates complimentary class
  • Class Types
    • List class types
    • Get class type details
  • Company level class types
    • List class types
  • Client Communication
    • Gets email log
    • Gets client interactions
    • Lists unified communication messages
  • Client Tasks
    • Gets client tasks
  • Client Sales
    • Gets client sales returns
    • Gets client payments
    • Lists client refunds
  • Client Waivers
    • Gets client waivers
  • Client Sessions
    • Gets client session inventory
  • Client Referrals
    • Lists client referrals
  • Client Offers
    • Lists eligible client coupons
  • Client Export
    • Exports prospects list
    • Exports ex-clients list
    • Exports active clients list
    • Exports clients at risk list
  • Client Billing
    • Creates charges for a client
    • Creates balance payment for invoice
  • Client Check-in
    • Creates client check-in
    • Lists client check-ins
    • Lists client check-ins by tenant
    • Lists clients who are currently in the club
    • Deletes a client check-in
  • Client Credit Balance
    • Creates a new credit balance order for a client
    • Retrieves the credit balance for a client
    • Retrieves the credit balance for a client
    • Lists client credit balance centerwise
  • Client Documents
    • Uploads client document
    • Gets client document
    • Lists client documents
    • Deletes client document
  • Client Invoices
    • Get invoice by UUID
    • Generate balance UUID for invoice
  • Client Membership
    • Change client membership start date
    • Patch client membership
    • Change client membership end date
    • Get client membership details
  • Client Open API
    • Create prospect
    • Book tour
  • Client Payments
    • Get payment timeline
      GET
    • List client payment methods
      GET
  • Client Subscriptions
    • List client subscription invoices
    • Get client subscription
    • List client subscriptions
    • Get clients by plan ID
    • Change subscription start date
    • Change subscription end date
    • Void client subscription
    • Send manage subscription link
    • Get client subscription by UUID
    • Get client subscription invoices by UUID
  • Client Memberships
    • Change session owner
    • Get session owners
    • List active client memberships
  • Client Subscription Cancellation
    • Cancel client subscription
    • Reactivate client subscription
  • Client Subscription Freeze
    • Create subscription freeze
    • List subscription freezes
    • Stop subscription freeze
    • Cancel subscription freeze
    • List client freezes
    • Get subscriptions available for freeze
    • Update subscription freeze
    • Get subscription freeze timeline
  • Client Trials
    • List client trials
    • Create client trial
    • Get client trial
    • Update trial
    • Delete client trial
    • Activate client trial
    • Mark trial as inactive
    • Mark trial as active
    • List client trials by tenant
    • Export client trials by tenant
  • Client Upgrade
    • Calculates subscription upgrade
    • Voids subscription upgrade
  • Balance Write Off
    • Creates a write off
    • Gets the list of write offs
    • Voids a write off
  • Email Template
    • Create email template
    • List email templates
    • Update email template
    • Get email template
    • Delete email template
    • Mark email template as inactive
    • Mark email template as active
  • 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
    • Create email template at tenant level
    • List email templates at tenant level
    • Update email template at tenant level
    • Get email template at tenant level
    • Delete email template at tenant level
    • Mark email template as inactive at tenant level
    • Mark email template as active at tenant level
  • Franchise Groups
    • Get franchise group details
    • List all franchise groups
  • Payment Methods
    • Initiate payment method update by UUID
    • Initiate payment method update by ID
  • Invoices
    • Get invoice
    • List client invoices
    • Void invoice
    • Get invoice PDF
    • Send invoice PDF
    • List invoice details
    • Change invoice sales rep
    • Send invoice clear balance link
  • Offer Master
    • List offer master
    • Get offer master
    • List eligible coupon master
    • List offer master coupon code link
    • List offer master service plan product link
    • List offer master organisation link
  • Online Signup
    • Get subscription plans
    • Get mandatory client fields
    • Get subscription plan details
    • Create client and invoice
  • Subscription
    • Get eligible add-ons
  • Sales
    • Get sales return PDF
  • 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
    • List opportunities
    • Create opportunity
    • Get opportunity
    • Update opportunity
    • Delete opportunity
    • Change opportunity stage
    • Mark opportunity as won
    • Mark opportunity as lost
    • Mark opportunity as nurture
    • Update opportunity sort order
  • Opportunity Stage Master
    • List opportunity stage masters
    • Get opportunity stage master
  • Payments
    • Get payment details
    • Mark payment as void
    • Get payment PDF
    • Send payment PDF
  • Refunds
    • List refunds
    • Send refund PDF
    • Get refund PDF
  • Reports
    • Reporting Quickstart
    • GET Report Data
  • Report Filter Schedules
    • Create report filter schedule
    • Delete report filter schedule
  • Access Requests
    • Request access via email
  • Rooms
    • List rooms
    • Get room details
  • Sales Returns
    • Get sales return PDF
  • Email Communication
    • Send free form email
  • SMS
    • Send free form SMS
  • Service Categories
    • List service categories
    • Get service category
    • Get service category collections
  • Staff Management
    • Get staff by ID
    • List all staff
    • List staff schedules
    • List staff appointment types
  • Staff Appointment Type Link
    • Gets staff appointment type links
  • Staff Notifications
    • Mark staff notifications as read
    • Mark staff notification as deleted
    • List staff notifications
  • Staff Schedule
    • Lists staff schedules
    • Gets staff schedule
  • Subscription Plans
    • List subscription plans
    • Get subscription plan by ID
    • Get eligible addons
  • Subscription Signup
    • Get Order Summary
    • Validate Referral
    • Get Order Summary Billing Occurrence
    • Get Order Status
    • Get Waivers
    • Get Payment Methods
    • List Empty Client Mandatory Fields
    • Sign Guest Waiver
    • Send Payment Link
    • Send Signup Completion Link
  • Tasks
    • Create task for client
    • Create task for opportunity
    • List tasks
    • Get task details
    • Complete SMS task
    • Bulk reassign tasks
  • Task Categories
    • List task categories
    • Get task category
  • Task Open API
    • Reschedule tour
    • Get tour details
  • Trial Master
    • List trials
    • Get trial
  1. Client Payments

Get payment timeline

GET
/clients/{client_id}/subscriptions/{clt_subs_id}/payment_timeline
Client Payments
Retrieves the payment timeline for a specific client subscription

Request

Path Params
client_id
integer <int64>
required
ID of the client
clt_subs_id
integer <int32>
required
ID of the client subscription

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//payment_timeline'

Responses

🟢200OK
text/plain
OK
Body
invoice_occurance
array[object (ClientSubscriptionRecurringBillingOccurrence) {17}]  | null 
optional
occurance_tenant_id
integer <int32>
optional
occurance_client_id
integer <int64>
optional
occurance_subscription_id
integer <int32>
optional
occurance
integer <int32>
optional
occurance_start_date
string <date-time>
optional
occurance_end_date
string <date-time>
optional
occurance_recurring_service
array[object (ClientRecurringMemberShipTemplateService) {28}]  | null 
optional
occurance_deposit_service
array[object (Client_Memberships) {50}]  | null 
optional
occurance_invoice_id
integer <int64>
optional
occurance_payment_id
integer <int64>
optional
occurance_payment_log_id
integer <int64>
optional
occurance_type
enum<string> 
optional
Available values:
InitialProRata -
Recurring -
Deposit -
MiddCycleDiscount -
MiddCycleAddon -
Freeze -
EndProrata -
InitialFullRecurring -
ProRataFutureRecurring -
Allowed values:
InitialProRataRecurringDepositMiddCycleDiscountMiddCycleAddonFreezeEndProrataInitialFullRecurringProRataFutureRecurring
payment_amount_in_minor_currency
integer <int64>
optional
invoice_amount_in_minor_currency
integer <int64>
optional
payment_status
enum<string> 
optional
Available values:
None -
Created -
Initiated -
Authorized -
Successfull -
Failed -
Allowed values:
NoneCreatedInitiatedAuthorizedSuccessfullFailed
failed_reason
string  | null 
optional
deposit_applied
boolean 
optional
Example
{
    "invoice_occurance": [
        {
            "occurance_tenant_id": 0,
            "occurance_client_id": 0,
            "occurance_subscription_id": 0,
            "occurance": 0,
            "occurance_start_date": "2019-08-24T14:15:22Z",
            "occurance_end_date": "2019-08-24T14:15:22Z",
            "occurance_recurring_service": [
                {
                    "svc_id": 0,
                    "service_pri_lang": "string",
                    "service_sec_lang": "string",
                    "svc_category_id": 0,
                    "svc_category_uuid": "string",
                    "svc_base_cost_in_minor_curr": 0,
                    "svc_sessions": 0,
                    "svc_category_name_pri_lang": "string",
                    "svc_category_name_sec_lang": "string",
                    "svc_category_description_pri_lang": "string",
                    "svc_category_description_sec_lang": "string",
                    "svc_behaviour": "MemberShip",
                    "svc_tax_item_code": "string",
                    "svc_is_base_membership": true,
                    "svc_require_base_membership": true,
                    "svc_is_session_owner_required": true,
                    "svc_session_owner_id": 0,
                    "svc_category_icon": "string",
                    "interval_type": "Day",
                    "interval_value": 0,
                    "start_date": "2019-08-24T14:15:22Z",
                    "end_date": "2019-08-24T14:15:22Z",
                    "svc_taxgrp_id": 0,
                    "discount_reason": "string",
                    "plan_id": 0,
                    "is_addons": true,
                    "membership_groupguid": "string",
                    "is_future_prorata": true
                }
            ],
            "occurance_deposit_service": [
                {
                    "clt_mbrshp_id": 0,
                    "clt_mbrshp_uuid": "string",
                    "clt_mbrshp_company_id": 0,
                    "clt_mbrshp_tenant_id": 0,
                    "clt_mbrshp_client_id": 0,
                    "clt_mbrshp_recurr_tmplt_id": 0,
                    "clt_mbrshp_invline_id": 0,
                    "clt_mbrshp_inv_id": 0,
                    "clt_mbrshp_clt_subscription_id": 0,
                    "clt_mbrshp_service_category_id": 0,
                    "clt_mbrshp_service_name_pri_lang": "string",
                    "clt_mbrshp_service_name_sec_lang": "string",
                    "clt_mbrshp_service_category_name_pri_lang": "string",
                    "clt_mbrshp_service_category_name_sec_lang": "string",
                    "clt_mbrshp_service_category_description_pri_lang": "string",
                    "clt_mbrshp_service_category_description_sec_lang": "string",
                    "clt_mbrshp_service_category_icon": "string",
                    "clt_mbrshp_svc_id": 0,
                    "clt_mbrshp_svc_tax_item_code": "string",
                    "clt_mbrshp_behaviour": "MemberShip",
                    "clt_mbrshp_is_base_membership": true,
                    "clt_mbrshp_start_date": "2019-08-24T14:15:22Z",
                    "clt_mbrshp_end_date": "2019-08-24T14:15:22Z",
                    "clt_mbrshp_no_of_session": 0,
                    "clt_mbrshp_valid_days": 0,
                    "clt_mbrshp_booked_session": 0,
                    "clt_mbrshp_used_sessions": 0,
                    "clt_mbrshp_noshow_sessions": 0,
                    "clt_mbrshp_available_sessions": 0,
                    "clt_mbrshp_session_carry_forward": 0,
                    "clt_mbrshp_session_owner_id": 0,
                    "clt_mbrshp_is_recurring": true,
                    "clt_mbrshp_trackmode": "StaffWebApp",
                    "clt_mbrshp_migration_id": "string",
                    "clt_mbrshp_created_by": 0,
                    "clt_mbrshp_created_date": "2019-08-24T14:15:22Z",
                    "clt_mbrshp_updated_by": 0,
                    "clt_mbrshp_updated_date": "2019-08-24T14:15:22Z",
                    "clt_mbrshp_interval_type": "Day",
                    "clt_mbrshp_interval_value": 0,
                    "clt_mbrshp_migration_inv_id": "string",
                    "clt_mbrshp_migration_invline_id": "string",
                    "clt_mbrshp_comments": "string",
                    "clt_mbrshp_is_renewed": true,
                    "clt_mbrshp_is_addons": true,
                    "clt_mbrshp_is_deposit": true,
                    "clt_mbrshp_deposit_occurence": 0,
                    "clt_mbrshp_deposit_uuid": "string",
                    "clt_mbrshp_revenue_category": "Unprocessed",
                    "clt_mbrshp_group_uuid": "string"
                }
            ],
            "occurance_invoice_id": 0,
            "occurance_payment_id": 0,
            "occurance_payment_log_id": 0,
            "occurance_type": "InitialProRata",
            "payment_amount_in_minor_currency": 0,
            "invoice_amount_in_minor_currency": 0,
            "payment_status": "None",
            "failed_reason": "string",
            "deposit_applied": true
        }
    ]
}
Modified at 2025-03-21 07:23:14
Previous
Book tour
Next
List client payment methods
Built with