CompTeam Memberships API
The Memberships API from CompTeam — 21 operation(s) for memberships.
The Memberships API from CompTeam — 21 operation(s) for memberships.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/compteam-io:compteam-io-memberships-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Compteam Io Memberships API
version: 0.1.0
description: 'Operations tagged Memberships across 2 of this provider''s published API definitions: compteam-io-openapi.json, compteam-io-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.compteam.io
description: C-TEAM API host serving this spec and its Swagger UI at /docs
tags:
- name: Memberships
paths:
/api/v1/memberships/sync-due-plan-changes:
post:
tags:
- Memberships
summary: Sync Due Membership Plan Changes
operationId: sync_due_membership_plan_changes_api_v1_memberships_sync_due_plan_changes_post
security:
- HTTPBearer: []
parameters:
- name: x-cron-secret
in: header
required: false
schema:
type: string
title: X-Cron-Secret
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/memberships/expire-trials:
post:
tags:
- Memberships
summary: Expire Membership Trials
description: 'Cron-triggered: deactivate branch memberships whose trial has ended.'
operationId: expire_membership_trials_api_v1_memberships_expire_trials_post
security:
- HTTPBearer: []
parameters:
- name: x-cron-secret
in: header
required: false
schema:
type: string
title: X-Cron-Secret
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/memberships/plans:
get:
tags:
- Memberships
summary: List Plans
operationId: list_plans_api_v1_memberships_plans_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: include_inactive
in: query
required: false
schema:
type: boolean
default: false
title: Include Inactive
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- Memberships
summary: Create Plan
operationId: create_plan_api_v1_memberships_plans_post
security:
- HTTPBearer: []
- HTTPBearer: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MembershipPlanCreate'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/memberships/plans/{plan_id}:
get:
tags:
- Memberships
summary: Get Plan
operationId: get_plan_api_v1_memberships_plans__plan_id__get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: plan_id
in: path
required: true
schema:
type: string
format: uuid
title: Plan Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
patch:
tags:
- Memberships
summary: Update Plan
operationId: update_plan_api_v1_memberships_plans__plan_id__patch
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: plan_id
in: path
required: true
schema:
type: string
format: uuid
title: Plan Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MembershipPlanUpdate'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Memberships
summary: Delete Plan
operationId: delete_plan_api_v1_memberships_plans__plan_id__delete
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: plan_id
in: path
required: true
schema:
type: string
format: uuid
title: Plan Id
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/memberships/:
get:
tags:
- Memberships
summary: List Branch Memberships
operationId: list_branch_memberships_api_v1_memberships__get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
security:
- HTTPBearer: []
- HTTPBearer: []
post:
tags:
- Memberships
summary: Create Membership
operationId: create_membership_api_v1_memberships__post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MembershipCreate'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
- HTTPBearer: []
/api/v1/memberships/athlete/{athlete_id}:
get:
tags:
- Memberships
summary: Get Athlete Membership
operationId: get_athlete_membership_api_v1_memberships_athlete__athlete_id__get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: athlete_id
in: path
required: true
schema:
type: string
format: uuid
title: Athlete Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/memberships/athlete/{athlete_id}/pause-requests:
get:
tags:
- Memberships
summary: List Athlete Pause Requests
operationId: list_athlete_pause_requests_api_v1_memberships_athlete__athlete_id__pause_requests_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: athlete_id
in: path
required: true
schema:
type: string
format: uuid
title: Athlete Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/memberships/athlete/{athlete_id}/pause-requests/{request_id}/decision:
post:
tags:
- Memberships
summary: Decide Athlete Pause Request
operationId: decide_athlete_pause_request_api_v1_memberships_athlete__athlete_id__pause_requests__request_id__decision_post
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: athlete_id
in: path
required: true
schema:
type: string
format: uuid
title: Athlete Id
- name: request_id
in: path
required: true
schema:
type: string
format: uuid
title: Request Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PauseDecisionRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/memberships/me:
get:
tags:
- Memberships
summary: Get My Membership
operationId: get_my_membership_api_v1_memberships_me_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
security:
- HTTPBearer: []
- HTTPBearer: []
/api/v1/memberships/me/history:
get:
tags:
- Memberships
summary: Get My Membership History
operationId: get_my_membership_history_api_v1_memberships_me_history_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
security:
- HTTPBearer: []
- HTTPBearer: []
/api/v1/memberships/me/pause-requests:
get:
tags:
- Memberships
summary: List My Pause Requests
operationId: list_my_pause_requests_api_v1_memberships_me_pause_requests_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
security:
- HTTPBearer: []
- HTTPBearer: []
post:
tags:
- Memberships
summary: Request My Membership Pause
operationId: request_my_membership_pause_api_v1_memberships_me_pause_requests_post
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_request_my_membership_pause_api_v1_memberships_me_pause_requests_post'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
- HTTPBearer: []
/api/v1/memberships/me/agreement-preview:
get:
tags:
- Memberships
summary: Get Membership Agreement Preview
operationId: get_membership_agreement_preview_api_v1_memberships_me_agreement_preview_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: plan_id
in: query
required: true
schema:
type: string
format: uuid
title: Plan Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/memberships/me/subscribe:
post:
tags:
- Memberships
summary: Subscribe To Plan
operationId: subscribe_to_plan_api_v1_memberships_me_subscribe_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/app__api__v1__endpoints__memberships__SubscribeRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
- HTTPBearer: []
/api/v1/memberships/me/cancel:
post:
tags:
- Memberships
summary: Cancel My Membership
operationId: cancel_my_membership_api_v1_memberships_me_cancel_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SelfCancelMembershipRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
- HTTPBearer: []
/api/v1/memberships/me/cancel/revoke:
post:
tags:
- Memberships
summary: Revoke My Membership Cancellation
operationId: revoke_my_membership_cancellation_api_v1_memberships_me_cancel_revoke_post
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
security:
- HTTPBearer: []
- HTTPBearer: []
/api/v1/memberships/me/change:
post:
tags:
- Memberships
summary: Change My Plan
operationId: change_my_plan_api_v1_memberships_me_change_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangePlanRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
- HTTPBearer: []
/api/v1/memberships/athlete/{athlete_id}/change-plan:
post:
tags:
- Memberships
summary: Change Athlete Plan As Staff
operationId: change_athlete_plan_as_staff_api_v1_memberships_athlete__athlete_id__change_plan_post
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: athlete_id
in: path
required: true
schema:
type: string
format: uuid
title: Athlete Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StaffChangePlanRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/memberships/athlete/{athlete_id}/change-plan-preview:
get:
tags:
- Memberships
summary: Preview Athlete Plan Change As Staff
operationId: preview_athlete_plan_change_as_staff_api_v1_memberships_athlete__athlete_id__change_plan_preview_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: athlete_id
in: path
required: true
schema:
type: string
format: uuid
title: Athlete Id
- name: plan_id
in: query
required: true
schema:
type: string
format: uuid
title: Plan Id
- name: effective_on
in: query
required: true
schema:
type: string
format: date
title: Effective On
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/memberships/athlete/{athlete_id}/history:
get:
tags:
- Memberships
summary: Get Athlete Membership History
operationId: get_athlete_membership_history_api_v1_memberships_athlete__athlete_id__history_get
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: athlete_id
in: path
required: true
schema:
type: string
format: uuid
title: Athlete Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/memberships/{membership_id}/status:
patch:
tags:
- Memberships
summary: Update Membership Status
operationId: update_membership_status_api_v1_memberships__membership_id__status_patch
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: membership_id
in: path
required: true
schema:
type: string
format: uuid
title: Membership Id
- name: status
in: query
required: true
schema:
type: string
title: Status
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/memberships/{membership_id}/cancel:
post:
tags:
- Memberships
summary: Cancel Membership As Staff
operationId: cancel_membership_as_staff_api_v1_memberships__membership_id__cancel_post
security:
- HTTPBearer: []
- HTTPBearer: []
parameters:
- name: membership_id
in: path
required: true
schema:
type: string
format: uuid
title: Membership Id
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/CancelMembershipRequest'
- type: 'null'
title: Body
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
MembershipPlanCreate:
properties:
name:
type: string
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
price_amount:
anyOf:
- type: number
minimum: 0.0
- type: string
- type: 'null'
title: Price Amount
currency:
anyOf:
- type: string
- type: 'null'
title: Currency
billing_interval:
type: string
title: Billing Interval
default: month
stripe_price_id:
anyOf:
- type: string
- type: 'null'
title: Stripe Price Id
stripe_signup_fee_price_id:
anyOf:
- type: string
- type: 'null'
title: Stripe Signup Fee Price Id
signup_fee_amount:
anyOf:
- type: number
minimum: 0.0
- type: string
- type: 'null'
title: Signup Fee Amount
membership_cancellation_notice_months:
anyOf:
- type: integer
maximum: 12.0
minimum: 0.0
- type: 'null'
title: Membership Cancellation Notice Months
includes_gear_discount:
type: boolean
title: Includes Gear Discount
default: false
gear_discount_pct:
anyOf:
- type: number
maximum: 100.0
minimum: 0.0
- type: string
title: Gear Discount Pct
default: '0'
allowed_tiers:
anyOf:
- items:
type: string
enum:
- amateur
- amateur_reduced
- competitor
- kid
type: array
minItems: 1
- type: 'null'
title: Allowed Tiers
min_age_years:
anyOf:
- type: integer
maximum: 120.0
minimum: 0.0
- type: 'null'
title: Min Age Years
max_age_years:
anyOf:
- type: integer
maximum: 120.0
minimum: 0.0
- type: 'null'
title: Max Age Years
type: object
required:
- name
title: MembershipPlanCreate
SelfCancelMembershipRequest:
properties:
reason:
type: string
enum:
- financial_reasons
- relocation
- schedule_conflict
- health_or_injury
- dissatisfaction
- other
title: Reason
comment:
anyOf:
- type: string
maxLength: 1000
- type: 'null'
title: Comment
type: object
required:
- reason
title: SelfCancelMembershipRequest
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
StaffChangePlanRequest:
properties:
plan_id:
type: string
format: uuid
title: Plan Id
effective_on:
anyOf:
- type: string
format: date
- type: 'null'
title: Effective On
type: object
required:
- plan_id
title: StaffChangePlanRequest
CancelMembershipRequest:
properties:
cancelled_on:
anyOf:
- type: string
format: date
- type: 'null'
title: Cancelled On
type: object
title: CancelMembershipRequest
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
app__api__v1__endpoints__memberships__SubscribeRequest:
properties:
plan_id:
type: string
format: uuid
title: Plan Id
signer_name:
anyOf:
- type: string
maxLength: 200
minLength: 1
- type: 'null'
title: Signer Name
discount_code:
anyOf:
- type: string
maxLength: 64
- type: 'null'
title: Discount Code
type: object
required:
- plan_id
title: SubscribeRequest
ChangePlanRequest:
properties:
plan_id:
type: string
format: uuid
title: Plan Id
signer_name:
anyOf:
- type: string
maxLength: 200
minLength: 1
- type: 'null'
title: Signer Name
type: object
required:
- plan_id
title: ChangePlanRequest
MembershipCreate:
properties:
athlete_id:
type: string
format: uuid
title: Athlete Id
plan_id:
type: string
format: uuid
title: Plan Id
payment_method:
type: string
title: Payment Method
default: manual
started_at:
anyOf:
- type: string
- type: 'null'
title: Started At
trial_ends_at:
anyOf:
- type: string
- type: 'null'
title: Trial Ends At
notes:
anyOf:
- type: string
- type: 'null'
title: Notes
type: object
required:
- athlete_id
- plan_id
title: MembershipCreate
PauseDecisionRequest:
properties:
decision:
type: string
enum:
- approve
- reject
title: Decision
reason:
anyOf:
- type: string
maxLength: 500
- type: 'null'
title: Reason
type: object
required:
- decision
title: PauseDecisionRequest
MembershipPlanUpdate:
properties:
name:
anyOf:
- type: string
- type: 'null'
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
price_amount:
anyOf:
- type: number
minimum: 0.0
- type: string
- type: 'null'
title: Price Amount
currency:
anyOf:
- type: string
- type: 'null'
title: Currency
billing_interval:
anyOf:
- type: string
- type: 'null'
title: Billing Interval
stripe_price_id:
anyOf:
- type: string
- type: 'null'
title: Stripe Price Id
stripe_signup_fee_price_id:
anyOf:
- type: string
- type: 'null'
title: Stripe Signup Fee Price Id
signup_fee_amount:
anyOf:
- type: number
minimum: 0.0
- type: string
- type: 'null'
title: Signup Fee Amount
membership_cancellation_notice_months:
anyOf:
- type: integer
maximum: 12.0
minimum: 0.0
- type: 'null'
title: Membership Cancellation Notice Months
includes_gear_discount:
anyOf:
- type: boolean
- type: 'null'
title: Includes Gear Discount
gear_discount_pct:
anyOf:
- type: number
maximum: 100.0
minimum: 0.0
- type: string
- type: 'null'
title: Gear Discount Pct
is_active:
anyOf:
- type: boolean
- type: 'null'
title: Is Active
allowed_tiers:
anyOf:
- items:
type: string
enum:
- amateur
- amateur_reduced
- competitor
- kid
type: array
minItems: 1
- type: 'null'
title: Allowed Tiers
min_age_years:
anyOf:
- type: integer
maximum: 120.0
minimum: 0.0
- type: 'null'
title: Min Age Years
max_age_years:
anyOf:
- type: integer
maximum: 120.0
minimum: 0.0
- type: 'null'
title: Max Age Years
type: object
title: MembershipPlanUpdate
Body_request_my_membership_pause_api_v1_memberships_me_pause_requests_post:
properties:
reason:
type: string
title: Reason
start_month:
type: string
title: Start Month
end_month:
type: string
title: End Month
document:
anyOf:
- type: string
format: binary
- type: 'null'
title: Document
type: object
required:
- reason
- start_month
- end_month
title: Body_request_my_membership_pause_api_v1_memberships_me_pause_requests_post
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
x-refined-from:
- compteam-io-openapi.json
- compteam-io-openapi.yml