Change Updates

Do not miss any Class Manager API changes, ever again

Subscribe to the Class Manager API changelog to be up to date on recent changes.

RSS
Class Manager

Changelog

Last update:
Compare
11 structure changes including:
11 Modifications
Modified 11 Breaking
GET /v1/basket/{familyId}/quote
  • Response
  • 200 response Modified
    • application/json content type Modified
      • seasons property Modified
        • season property Modified
GET /v1/seasons/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • prorate property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /v1/seasons/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • prorate property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/checkout
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checkout property Modified
        • enrolments, dropIns, products, additionals properties Modified
POST /v1/seasons/
  • Body
  • application/json content type Modified
    • prorate property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • prorate property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/seasons/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • prorate property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/seasons/{id}/enrolment-status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • prorate property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/seasons/{id}/pricing-scheme
  • Response
  • 200 response Modified
    • application/json content type Modified
      • prorate property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/seasons/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • prorate property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /v1/seasons/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • prorate property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PUT /v1/seasons/{id}
  • Body
  • application/json content type Modified
    • prorate property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • prorate property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
11 structure changes including:
11 Modifications
Modified 11
GET /v1/basket/{familyId}/quote
  • Response
  • 200 response Modified
    • application/json content type Modified
      • seasons property Modified
        • season property Modified
GET /v1/seasons/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • prorate property Added
GET /v1/seasons/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • prorate property Added
POST /v1/checkout
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checkout property Modified
        • enrolments, dropIns, products, additionals properties Modified
POST /v1/seasons/
  • Body
  • application/json content type Modified
    • prorate property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • prorate property Added
POST /v1/seasons/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • prorate property Added
POST /v1/seasons/{id}/enrolment-status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • prorate property Added
POST /v1/seasons/{id}/pricing-scheme
  • Response
  • 200 response Modified
    • application/json content type Modified
      • prorate property Added
POST /v1/seasons/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • prorate property Added
POST /v1/seasons/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • prorate property Added
PUT /v1/seasons/{id}
  • Body
  • application/json content type Modified
    • prorate property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • prorate property Added
5 structure changes including:
5 Modifications
Modified 5
GET /v1/order/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • subs property Modified
        • items property Modified
POST /v1/order/{id}/add-payment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • subs property Modified
        • items property Modified
POST /v1/order/{id}/cancel-item
  • Response
  • 200 response Modified
    • application/json content type Modified
      • subs property Modified
        • items property Modified
POST /v1/order/{id}/charge-card-on-file
  • Response
  • 200 response Modified
    • application/json content type Modified
      • subs property Modified
        • items property Modified
POST /v1/order/{id}/record-stripe-payment
  • Response
  • 200 response Modified
    • application/json content type Modified
      • subs property Modified
        • items property Modified
11 structure changes including:
11 Modifications
Modified 11
GET /v1/auth/accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • CompanyDto property Modified
GET /v1/companies/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • settings property Modified
GET /v1/company/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • billing property Modified
GET /v1/company/{slug}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • billing property Modified
PATCH /v1/company/payouts/request-enable
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • billing property Modified
PATCH /v1/company/settings
  • Body
  • application/json content type Modified
    • billing property Modified
      • isProcessingFeeEnabled, processingFee properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • billing property Modified
PATCH /v1/company/settings/look-and-feel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • billing property Modified
POST /v1/auth/register/company
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • CompanyDto property Modified
POST /v1/payment-links/{paymentLinkId}/process
  • Response
  • 200 response Modified
    • application/json content type Modified
      • company property Modified
        • settings property Modified
PUT /v1/company
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • billing property Modified
PUT /v1/company/address
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • billing property Modified
11 structure changes including:
11 Modifications
Modified 11
GET /v1/basket/{familyId}/quote
  • Response
  • 200 response Modified
    • application/json content type Modified
      • seasons property Modified
        • season, enabledPricingPlans properties Modified
GET /v1/seasons/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • pricingPlans property Modified
GET /v1/seasons/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • installmentDates property Added
POST /v1/checkout
  • Response
  • 200 response Modified
    • application/json content type Modified
      • checkout property Modified
        • enrolments, dropIns, products, additionals properties Modified
POST /v1/seasons/
  • Body
  • application/json content type Modified
    • pricingPlans property Modified
      • installmentDates property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • installmentDates property Added
POST /v1/seasons/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • installmentDates property Added
POST /v1/seasons/{id}/enrolment-status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • installmentDates property Added
POST /v1/seasons/{id}/pricing-scheme
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • installmentDates property Added
POST /v1/seasons/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • installmentDates property Added
POST /v1/seasons/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • installmentDates property Added
PUT /v1/seasons/{id}
  • Body
  • application/json content type Modified
    • pricingPlans property Modified
      • installmentDates property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pricingPlans property Modified
        • installmentDates property Added
10 structure changes including:
10 Modifications
Modified 10
GET /v1/auth/accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • CompanyDto property Modified
GET /v1/companies/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • isClassicCustomer property Added
GET /v1/company/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isClassicCustomer property Added
PATCH /v1/company/payouts/request-enable
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isClassicCustomer property Added
PATCH /v1/company/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isClassicCustomer property Added
PATCH /v1/company/settings/look-and-feel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isClassicCustomer property Added
POST /v1/auth/register/company
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • CompanyDto property Modified
POST /v1/payment-links/{paymentLinkId}/process
  • Response
  • 200 response Modified
    • application/json content type Modified
      • company property Modified
        • isClassicCustomer property Added
PUT /v1/company
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isClassicCustomer property Added
PUT /v1/company/address
  • Response
  • 200 response Modified
    • application/json content type Modified
      • isClassicCustomer property Added
6 structure changes including:
6 Breaking changes
6 Removals
Removed 6 Breaking
DELETE /v1/integrations/quickbooks/reset
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/integrations/quickbooks/
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/integrations/quickbooks/sign-in-url
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/integrations/quickbooks/
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/integrations/quickbooks/disconnect
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/integrations/quickbooks/sync-all
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
10 structure changes including:
10 Modifications
Modified 10
GET /v1/basket/{familyId}/quote
  • Response
  • 200 response Modified
    • application/json content type Modified
      • seasons property Modified
        • season property Modified
GET /v1/seasons/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • additionalFees property Modified
GET /v1/seasons/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • additionalFees property Modified
        • proRated property Added
POST /v1/seasons/
  • Body
  • application/json content type Modified
    • additionalFees property Modified
      • proRated property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • additionalFees property Modified
        • proRated property Added
POST /v1/seasons/{id}/archive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • additionalFees property Modified
        • proRated property Added
POST /v1/seasons/{id}/enrolment-status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • additionalFees property Modified
        • proRated property Added
POST /v1/seasons/{id}/pricing-scheme
  • Response
  • 200 response Modified
    • application/json content type Modified
      • additionalFees property Modified
        • proRated property Added
POST /v1/seasons/{id}/restore
  • Response
  • 200 response Modified
    • application/json content type Modified
      • additionalFees property Modified
        • proRated property Added
POST /v1/seasons/{id}/unarchive
  • Response
  • 200 response Modified
    • application/json content type Modified
      • additionalFees property Modified
        • proRated property Added
PUT /v1/seasons/{id}
  • Body
  • application/json content type Modified
    • additionalFees property Modified
      • proRated property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • additionalFees property Modified
        • proRated property Added
1 structure change including:
1 Modification
Modified 1
GET /v1/orders
  • Query
  • where query parameter Modified
    • paid query parameter Added
      • DateFilterSchema, TextFilterSchema, NumberFilterSchema, DecimalFilterSchema, SelectFilterSchema, MultiSelectFilterSchema, BooleanFilterSchema query parameters Added
    • nextPaymentDueDate query parameter Added
      • DateFilterSchema, TextFilterSchema, NumberFilterSchema, DecimalFilterSchema, SelectFilterSchema, MultiSelectFilterSchema, BooleanFilterSchema query parameters Added
    • nextPaymentDueStatus query parameter Added
      • DateFilterSchema, TextFilterSchema, NumberFilterSchema, DecimalFilterSchema, SelectFilterSchema, MultiSelectFilterSchema, BooleanFilterSchema query parameters Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • nextPaymentDue, nextPaymentDueDate, nextPaymentDueStatus properties Added
1 structure change including:
1 Modification
Modified 1
POST /v1/auth/register/company
  • Body
  • application/json content type Modified
    • hutk property Added
12 structure changes including:
2 Additions
10 Modifications
Modified 10
GET /v1/auth/accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • CompanyDto property Modified
GET /v1/companies/
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • settings property Modified
GET /v1/company/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • integrations property Modified
GET /v1/company/{slug}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • integrations property Modified
PATCH /v1/company/settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • integrations property Modified
PATCH /v1/company/settings/look-and-feel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • integrations property Modified
POST /v1/auth/register/company
  • Response
  • 200 response Modified
    • application/json content type Modified
      • account property Modified
        • CompanyDto property Modified
POST /v1/payment-links/{paymentLinkId}/process
  • Response
  • 200 response Modified
    • application/json content type Modified
      • company property Modified
        • settings property Modified
PUT /v1/company
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • integrations property Modified
PUT /v1/company/address
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settings property Modified
        • integrations property Modified
Added 2
PATCH /v1/admin/companies/{company}/payouts/status
PATCH /v1/company/payouts/request-enable
1 structure change including:
1 Addition
Added 1
GET /v1/companies/{company}/accounts
1 structure change including:
1 Addition
Added 1
GET /v1/reporting/order/export
1 structure change including:
1 Modification
Modified 1
GET /v1/drop-ins
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • courseName, WeekDay, courseTime, courseDuration, LessonAdjustmentReason properties Added
1 structure change including:
1 Breaking change
1 Removal
Removed 1 Breaking
POST /v1/demos/clear
  • Removing a resource is always breaking unless it was deprecated before
    Breaking