Access tokens1

Account links1

Accounts11

Ad Campaigns9

Ad Groups10

Ad reports1

Ads8

Affiliates10

Ai chats5

API Keys7

Api Logs1

App Builds4

Apps9

Audiences5

Authorized users4

Bounties7

Bounty Submissions5

Cards6

Chat channels3

Checkout Configurations4

Companies5

Company token transactions3

Confirmation Tokens2

Course chapters5

Course lesson interactions2

Course lessons8

Course students2

Courses5

Deposits1

Dispute alerts2

Disputes8

Dm channels5

Dm members5

Entries4

Events4

Experiences8

Exports3

Fee markups3

Files4

Forum posts4

Forums3

Identity profiles4

Invoices9

Leads4

Ledger accounts1

Ledgers3

Media2

Members3

Memberships12

Messages5

Notifications6

Partners6

Payment Method Domains5

Payment methods3

Payments10

Payout accounts1

Payout methods2

Payouts10

People2

Permissions1

Plans6

Products7

Promo Codes6

Reactions4

Recommended Actions4

Refunds2

Resolution Center Cases11

Reviews2

Setup intents3

Setup Intents2

Shipments4

Social Accounts6

Stats5

Support channels3

Swaps4

Team Members5

Topups1

Transfers4

Users18

Verifications4

Webhooks10

Webhooks

Accounts1

Ad Campaigns1

Cards13

Course lesson interactions1

Deposits1

Dispute alerts1

Disputes2

Entries4

Exports2

Invoices5

Ledger accounts1

Members1

Memberships4

Messages1

Payments6

Payout accounts1

Payouts4

Plans3

Products5

Reactions1

Refunds2

Resolution Center Cases3

Setup intents3

Shipments2

Swaps1

Transfers3

Verifications2

Memberships

Pause Membership

Pauses a membership's recurring payment collection. The customer keeps access but is not charged until the membership is resumed.

post/memberships/{id}/pause

Headers

Idempotency-Keystring

Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

untilstring

ISO 8601 time to automatically resume payment collection. Must be in the future; only supported for memberships billed by Whop.

Example request

{
  "until": "2026-01-01T12:00:00.000Z"
}

Response

membership paused

cancel_at_period_endboolean required

Whether the membership is set to cancel when the current billing period ends. Only meaningful for recurring plans.

created_atstring required

When the membership was created, as an ISO 8601 timestamp.

current_period_endstring nullable required

When the current billing period renews, or when a non-renewing membership expires, as an ISO 8601 timestamp. null for one-time purchases with no expiration.

idstring required

Membership ID, prefixed mem_.

license_keystring nullable required

The software license key for this membership. Only present when the product includes a software licensing experience.

metadataobject required

Custom key-value pairs stored on the membership, commonly used for software licensing.

phone_numberstring nullable required

The buyer's phone number recorded for this membership, or null. The number collected (or verified) at checkout when the seller's phone collection is on; falls back to the buyer's account number when they have shared one with this seller.

plan_idstring required

The plan the buyer purchased, prefixed plan_.

product_idstring required

The product this membership grants access to, prefixed prod_.

Billing state of the membership. active/trialing memberships grant access; past_due is the grace period after a failed payment; completed one-time purchases keep access; canceled/expired do not.

user_idstring nullable required

The buyer, prefixed user_. null when the buyer is another business or the membership is unclaimed.

Example response

{
  "account": {
    "id": "biz_xxxxxxxxxxxxxx",
    "logo_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "route": "shine-time-auto-detailing",
    "title": "Shine Time Auto Detailing"
  },
  "created_at": "2026-01-01T12:00:00.000Z",
  "current_period_end": "2026-01-01T12:00:00.000Z",
  "id": "mem_xxxxxxxxxxxxxx",
  "license_key": "WHOP-XXXX-XXXX-XXXX",
  "member": {
    "access_level": "customer",
    "last_accessed_at": "2026-01-01T12:00:00.000Z",
    "position": 1767268800000
  },
  "metadata": {},
  "phone_number": "+xxxxxxxxxxx",
  "plan_id": "plan_xxxxxxxxxxxxxx",
  "product_id": "prod_xxxxxxxxxxxxxx",
  "status": "active",
  "user_id": "user_xxxxxxxxxxxxxx"
}

Changes

Changed in 4 of the 41 revisions of this API.21621

Aug 27, 202616c82685be351See the full diff
- ○
  added the required property phone_number to the response with the 200 status
  response-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 12, 2026ae20b30817de1See the full diff
- ○
  added the non-success response with the status 409
  response-non-success-status-added
Aug 7, 2026f1020c3ecda42See the full diff
- ○
  added the optional property error/code to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property error/code to the response with the 403 status
  response-optional-property-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 26, 202660bbb4a6ffbc21617See the full diff
- ▲
  added MembershipMember subschema #2 to the member response property oneOf list for the response status 200
  response-property-one-of-added
- ▲
  the created_at response's property type/format changed from string/date-time to string/ for status 200
  response-property-type-changed
- ▲
  the member response's property type/format changed from object null/ to / for status 200
  response-property-type-changed
- ▲
  removed the required property cancel_option from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property canceled_at from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property cancellation_reason from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property checkout_configuration_id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property company from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property currency from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property custom_field_responses from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property joined_at from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property manage_url from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property member/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property payment_collection_paused from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property plan from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property product from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property promo_code from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property renewal_period_end from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property renewal_period_start from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property updated_at from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property user from the response with the 200 status
  response-required-property-removed
- ●
  deleted the path request parameter id
  request-parameter-removed
- ●
  removed the request property void_payments
  request-property-removed
- ●
  removed the optional property error/code from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property error/code from the response with the 403 status
  response-optional-property-removed
- ●
  removed the optional property error/param from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property error/param from the response with the 403 status
  response-optional-property-removed
- ○
  the security scope member:basic:read was removed from the endpoint's security scheme bearerAuth
  api-security-scope-removed
- ○
  the security scope member:email:read was removed from the endpoint's security scheme bearerAuth
  api-security-scope-removed
- ○
  added the new optional header request parameter Api-Version-Date to all path's operations
  new-optional-request-default-parameter-to-existing-path
- ○
  added the new optional header request parameter Idempotency-Key
  new-optional-request-parameter
- ○
  added the new optional request property until
  new-optional-request-property
- ○
  removed the non-success response with the status 401
  response-non-success-status-removed
- ○
  removed the non-success response with the status 404
  response-non-success-status-removed
- ○
  removed the non-success response with the status 422
  response-non-success-status-removed
- ○
  removed the non-success response with the status 429
  response-non-success-status-removed
- ○
  removed the non-success response with the status 500
  response-non-success-status-removed
- ○
  removed the canceling enum value from the status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the drafted enum value from the status response property for the response status 200
  response-property-enum-value-removed
- ○
  added the required property account to the response with the 200 status
  response-required-property-added
- ○
  added the required property current_period_end to the response with the 200 status
  response-required-property-added
- ○
  added the required property plan_id to the response with the 200 status
  response-required-property-added
- ○
  added the required property product_id to the response with the 200 status
  response-required-property-added
- ○
  added the required property user_id to the response with the 200 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history