> ## Documentation Index > Fetch the complete documentation index at: https://docs.1club.ai/llms.txt > Use this file to discover all available pages before exploring further. # Update a membership > Changes whether the membership renews, when it ends, and whether it is active, paused, or cancelled. Cancelling stamps the cancellation date, as cancelling in 1club does. Changing the plan is not supported: that is a priced change needing proration, invoicing and possibly a refund. Move the customer to another plan in 1club instead. ## OpenAPI ````yaml /openapi-platform.json patch /v1/platform/memberships/{id} openapi: 3.0.0 info: title: 1club Platform API version: 1.0.0 description: >- The 1club Platform API lets you programmatically access and manage your organization's data. ## Official API Contract This documentation is the official source of truth for the 1club Platform API. If an integration relies on undocumented endpoints, fields, response shapes, or internal behavior outside this spec, we can't guarantee backward compatibility. Build against what's documented here to stay stable as the platform evolves. ## Authentication All requests require a customer API key passed as a Bearer token: ``` Authorization: Bearer 1club_sk_live_... ``` Generate API keys from the admin portal under **Settings > API Tokens**. The key is tied to your organization - all responses are scoped to your org's data. ## Rate Limiting - **100 requests per minute** per API key - When exceeded, the API returns `429 Too Many Requests` with a `Retry-After` header - Rate limit headers are included in every response: - `X-RateLimit-Limit` - max requests per window - `X-RateLimit-Remaining` - requests remaining - `X-RateLimit-Reset` - seconds until the window resets ## Errors | Status | Meaning | |--------|---------| | `400` | Invalid request parameters | | `401` | Missing or invalid API key | | `404` | Resource not found (or doesn't belong to your organization) | | `429` | Rate limit exceeded | | `500` | Internal server error | contact: name: 1club API Support email: support@1club.ai servers: - url: https://api.1club.ai description: Production API security: - customerApiAuth: [] tags: [] paths: /v1/platform/memberships/{id}: patch: tags: - Memberships summary: Update a membership description: > Changes whether the membership renews, when it ends, and whether it is active, paused, or cancelled. Cancelling stamps the cancellation date, as cancelling in 1club does. Changing the plan is not supported: that is a priced change needing proration, invoicing and possibly a refund. Move the customer to another plan in 1club instead. parameters: - in: path name: id required: true schema: type: integer requestBody: required: true content: application/json: schema: type: object properties: status: type: string enum: - active - paused - cancelled description: > Statuses the platform derives itself (expired, used, pending_payment) cannot be set here. Send `status` on its own - `autoRenew` and the allowance fields cannot be combined with it, because a status transition sets them itself. `active` only applies to a paused membership. cancelMode: type: string enum: - immediate - end_of_period default: end_of_period description: >- Only valid with `status: cancelled`. Keep access until the paid period ends, or end it today. resumeAt: type: string format: date-time nullable: true description: >- Only valid with `status: paused`. When the pause lifts by itself; must be in the future. autoRenew: type: boolean maxUses: type: number nullable: true description: Session allowance; null for unlimited usesRemaining: type: number nullable: true description: Sessions left, for correcting a balance after a migration responses: '200': description: The updated membership content: application/json: schema: $ref: '#/components/schemas/PlatformMembership' '400': description: Invalid body, or no fields to change content: application/json: schema: $ref: '#/components/schemas/PlatformError' '401': $ref: '#/components/responses/PlatformUnauthorized' '403': description: API key is missing the required `memberships:write` scope content: application/json: schema: $ref: '#/components/schemas/PlatformError' '404': $ref: '#/components/responses/PlatformNotFound' '429': $ref: '#/components/responses/PlatformRateLimited' security: - customerApiAuth: [] components: schemas: PlatformMembership: type: object description: >- A customer's membership on a plan. The plan is snapshotted onto it at creation, so allowance and coverage behave exactly as they do for a membership sold in 1club. properties: membershipId: type: integer membershipUuid: type: string format: uuid description: >- Stable unguessable identifier. Prefer this over `membershipId` when storing a reference. contactId: type: integer description: Customer the membership belongs to planId: type: integer planName: type: string nullable: true clubId: type: integer nullable: true description: >- Club the membership is limited to; null when it applies organization-wide. status: type: string description: >- active, paused, cancelled, expired, used, pending, or pending_payment startDate: type: string format: date-time endDate: type: string format: date-time nullable: true renewalDate: type: string format: date-time nullable: true autoRenew: type: boolean price: type: number nullable: true billingFrequency: type: string maxUses: type: number nullable: true description: Session allowance snapshotted from the plan; null when unlimited. usesRemaining: type: number nullable: true createdAt: type: string format: date-time PlatformError: type: object properties: error: type: string responses: PlatformUnauthorized: description: Invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/PlatformError' PlatformNotFound: description: The requested resource does not exist in this organization content: application/json: schema: $ref: '#/components/schemas/PlatformError' PlatformRateLimited: description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/PlatformError' securitySchemes: customerApiAuth: type: http scheme: bearer description: >- Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token. ````