> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # Pause membership > Pause a membership's recurring payments. The customer retains access but will not be charged until the membership is resumed. Required permissions: - `member:manage` - `member:email:read` - `member:basic:read` ## OpenAPI ````yaml https://app.stainless.com/api/spec/documented/whopsdk/openapi.documented.yml post /memberships/{id}/pause openapi: 3.1.0 info: title: Whop API description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ version: 1.0.0 servers: - url: https://api.whop.com/api/v1 description: Production Whop API security: [] tags: - name: Products description: Products - name: Plans description: Plans - name: Payments description: Payments - name: Refunds description: Refunds - name: Disputes description: Disputes - name: Dispute alerts description: Dispute alerts - name: Resolution center cases description: Resolution center cases - name: Checkout configurations description: Checkout configurations - name: Setup intents description: Setup intents - name: Payment methods description: Payment methods - name: Invoices description: Invoices - name: Promo codes description: Promo codes - name: Card transactions description: Card transactions - name: Ledger accounts description: Ledger accounts - name: Transfers description: Transfers - name: Withdrawals description: Withdrawals - name: Payout methods description: Payout methods - name: Verifications description: Verifications - name: Payout accounts description: Payout accounts - name: Topups description: Topups - name: Users description: Users - name: Companies description: Companies - name: Authorized users description: Authorized users - name: Fee markups description: Fee markups - name: Members description: Members - name: Memberships description: Memberships - name: Leads description: Leads - name: Entries description: Entries - name: Shipments description: Shipments - name: Reviews description: Reviews - name: Company token transactions description: Company token transactions - name: Affiliates description: Affiliates - name: Experiences description: Experiences - name: Forums description: Forums - name: Forum posts description: Forum posts - name: Chat channels description: Chat channels - name: Support channels description: Support channels - name: Messages description: Messages - name: Reactions description: Reactions - name: Dm members description: Dm members - name: Dm channels description: Dm channels - name: Notifications description: Notifications - name: Courses description: Courses - name: Course chapters description: Course chapters - name: Course lessons description: Course lessons - name: Course students description: Course students - name: Course lesson interactions description: Course lesson interactions - name: Apps description: Apps - name: Webhooks description: Webhooks - name: App builds description: App builds - name: Access tokens description: Access tokens - name: Account links description: Account links - name: Files description: Files - name: Ai chats description: Ai chats - name: Bounties description: Bounties - name: Stats description: Stats - name: Ad campaigns description: Ad campaigns - name: Ad groups description: Ad groups - name: Ads description: Ads - name: Conversions description: Conversions paths: /memberships/{id}/pause: post: tags: - Memberships summary: Pause membership description: >- Pause a membership's recurring payments. The customer retains access but will not be charged until the membership is resumed. Required permissions: - `member:manage` - `member:email:read` - `member:basic:read` operationId: pauseMembership parameters: - name: id in: path required: true description: The unique identifier of the membership to pause. schema: type: string example: mem_xxxxxxxxxxxxxx requestBody: required: false content: application/json: schema: type: object properties: void_payments: type: - boolean - 'null' description: >- Whether to void any outstanding past-due payments on this membership, preventing future collection attempts. required: [] description: Parameters for PauseMembership responses: '200': description: A successful response content: application/json: schema: $ref: '#/components/schemas/Membership' '400': description: Bad request content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: invalid_request_error code: parameter_missing message: 'Missing required parameter: amount.' param: amount '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: unauthorized message: Invalid or missing API key '403': description: Forbidden content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: forbidden message: You do not have permission to access this resource '404': description: Not found content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: not_found message: Resource not found '422': description: Verification required content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: null '500': description: Internal server error content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: internal_server_error message: An unexpected error occurred security: - bearerAuth: - member:manage - member:email:read - member:basic:read x-codeSamples: - lang: JavaScript source: >- import Whop from '@whop/sdk'; const client = new Whop({ apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted }); const membership = await client.memberships.pause('mem_xxxxxxxxxxxxxx'); console.log(membership.id); - lang: Python source: |- import os from whop_sdk import Whop client = Whop( api_key=os.environ.get("WHOP_API_KEY"), # This is the default and can be omitted ) membership = client.memberships.pause( id="mem_xxxxxxxxxxxxxx", ) print(membership.id) - lang: Ruby source: |- require "whop_sdk" whop = WhopSDK::Client.new(api_key: "My API Key") membership = whop.memberships.pause("mem_xxxxxxxxxxxxxx") puts(membership) components: schemas: Membership: type: object properties: id: type: string description: The unique identifier for the membership. example: mem_xxxxxxxxxxxxxx status: $ref: '#/components/schemas/MembershipStatus' description: >- The current lifecycle status of the membership (e.g., active, trialing, past_due, canceled, expired, completed). created_at: type: string format: date-time description: The datetime the membership was created. example: '2023-12-01T05:00:00.401Z' joined_at: type: - string - 'null' format: date-time description: >- The time the user first joined the company associated with this membership. As a Unix timestamp. Null if the member record does not exist. example: '2023-12-01T05:00:00.401Z' updated_at: type: string format: date-time description: The datetime the membership was last updated. example: '2023-12-01T05:00:00.401Z' manage_url: type: - string - 'null' description: >- The URL where the customer can view and manage this membership, including cancellation and plan changes. Null if no member record exists. example: https://whop.com/billing/manage/mem_abc123 member: type: - object - 'null' properties: id: type: string description: The unique identifier for the member. example: mber_xxxxxxxxxxxxx required: - id description: >- The member record linking the user to the company for this membership. Null if the member record has not been created yet. user: type: - object - 'null' properties: id: type: string description: The unique identifier for the user. example: user_xxxxxxxxxxxxx username: type: string description: The user's unique username shown on their public profile. example: johndoe42 name: type: - string - 'null' description: The user's display name shown on their public profile. example: John Doe email: type: - string - 'null' description: >- The user's email address. Requires the member:email:read permission to access. Null if not authorized. example: john.doe@example.com required: - id - username - name - email description: >- The user who owns this membership. Null if the user account has been deleted. renewal_period_start: type: - string - 'null' format: date-time description: >- The start of the current billing period for this recurring membership. As a Unix timestamp. Null if the membership is not recurring. example: '2023-12-01T05:00:00.401Z' renewal_period_end: type: - string - 'null' format: date-time description: >- The end of the current billing period for this recurring membership. As a Unix timestamp. Null if the membership is not recurring. example: '2023-12-01T05:00:00.401Z' cancel_at_period_end: type: boolean description: >- Whether this membership is set to cancel at the end of the current billing cycle. Only applies to memberships with a recurring plan. cancel_option: oneOf: - $ref: '#/components/schemas/CancelOptions' - type: 'null' description: >- The category selected for why the member canceled (e.g. too_expensive, switching, missing_features). cancellation_reason: type: - string - 'null' description: >- Free-text explanation provided by the customer when canceling. Null if the customer did not provide a reason. example: I found a better alternative. canceled_at: type: - string - 'null' format: date-time description: >- The time the customer initiated cancellation of this membership. As a Unix timestamp. Null if the membership has not been canceled. example: '2023-12-01T05:00:00.401Z' currency: oneOf: - $ref: '#/components/schemas/Currencies' - type: 'null' description: >- The three-letter ISO currency code for this membership's billing. Null if the membership is free. company: type: object properties: id: type: string description: The unique identifier for the company. example: biz_xxxxxxxxxxxxxx title: type: string description: The display name of the company shown to customers. example: Pickaxe required: - id - title description: The company this membership belongs to. plan: type: object properties: id: type: string description: The unique identifier for the plan. example: plan_xxxxxxxxxxxxx required: - id description: The plan the customer purchased to create this membership. promo_code: type: - object - 'null' properties: id: type: string description: The unique identifier for the promo code. example: promo_xxxxxxxxxxxx required: - id description: >- The promotional code currently applied to this membership's billing. Null if no promo code is active. product: type: object properties: id: type: string description: The unique identifier for the product. example: prod_xxxxxxxxxxxxx title: type: string description: >- The display name of the product shown to customers on the product page and in search results. example: Pickaxe Analytics required: - id - title description: The product this membership grants access to. license_key: type: - string - 'null' description: >- The software license key associated with this membership. Only present if the product includes a Whop Software Licensing experience. Null otherwise. example: A1B2C3-D4E5F6-G7H8I9 metadata: type: - object - 'null' additionalProperties: true description: >- Custom key-value pairs for the membership (commonly used for software licensing, e.g., HWID). Max 50 keys, 500 chars per key, 5000 chars per value. payment_collection_paused: type: boolean description: >- Whether recurring payment collection for this membership is temporarily paused by the company. checkout_configuration_id: type: - string - 'null' description: >- The ID of the checkout session/configuration that produced this membership, if any. Use this to map memberships back to the checkout configuration that created them. custom_field_responses: type: array items: type: object properties: id: type: string description: The unique identifier for the custom field response. example: cfrp_xxxxxxxxxxxxx question: type: string description: The question asked by the custom field answer: type: string description: The response a user gave to the specific question or field. required: - id - question - answer description: The response from a custom field on checkout description: >- The customer's responses to custom checkout questions configured on the product at the time of purchase. required: - id - status - created_at - joined_at - updated_at - manage_url - member - user - renewal_period_start - renewal_period_end - cancel_at_period_end - cancel_option - cancellation_reason - canceled_at - currency - company - plan - promo_code - product - license_key - metadata - payment_collection_paused - checkout_configuration_id - custom_field_responses description: >- A membership represents an active relationship between a user and a product. It tracks the user's access, billing status, and renewal schedule. MembershipStatus: type: string enum: - trialing - active - past_due - completed - canceled - expired - unresolved - drafted - canceling description: The status of a membership CancelOptions: type: string enum: - too_expensive - switching - missing_features - technical_issues - bad_experience - other - testing description: >- The different reasons a user can choose for why they are canceling their membership. Currencies: type: string enum: - usd - sgd - inr - aud - brl - cad - dkk - eur - nok - gbp - sek - chf - hkd - huf - jpy - mxn - myr - pln - czk - nzd - aed - eth - ape - cop - ron - thb - bgn - idr - dop - php - try - krw - twd - vnd - pkr - clp - uyu - ars - zar - dzd - tnd - mad - kes - kwd - jod - all - xcd - amd - bsd - bhd - bob - bam - khr - crc - xof - egp - etb - gmd - ghs - gtq - gyd - ils - jmd - mop - mga - mur - mdl - mnt - nad - ngn - mkd - omr - pyg - pen - qar - rwf - sar - rsd - lkr - tzs - ttd - uzs - rub - btc - cny - usdt - kzt description: The available currencies on the platform securitySchemes: bearerAuth: type: http description: >- A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like `Bearer ***************************` scheme: bearer bearerFormat: auth-scheme ````