Update a Membership - Whop Developers

curl --request PATCH \
  --url https://api.whop.com/api/v5/company/memberships/{id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "metadata": {}
}'

{
  "affiliate_username": "<string>",
  "cancel_at_period_end": true,
  "checkout_id": "<string>",
  "company_buyer_id": "<string>",
  "created_at": 123,
  "expires_at": 123,
  "id": "<string>",
  "license_key": "<string>",
  "manage_url": "<string>",
  "marketplace": true,
  "metadata": {},
  "page_id": "<string>",
  "plan_id": "<string>",
  "product_id": "<string>",
  "quantity": 123,
  "renewal_period_end": 123,
  "renewal_period_start": 123,
  "status": "trialing",
  "user_id": "<string>",
  "valid": true
}

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

The ID of the membership, which will look like mem_*************

Body

application/json

metadata

object

required

The metadata for the membership.

Response

200 - application/json

affiliate_username

string

The username of the affiliate that referred the customer to this membership, if any.

cancel_at_period_end

boolean

Whether or not this membership is scheduled to cancel at the end of the renewal period.

checkout_id

string

The ID of the checkout used to first purchase / generate the membership.

company_buyer_id

string

The ID of the company that purchased/owns the membership. (For example, they installed an app). Looks like biz_*************

created_at

number

required

The time at which the Membership was created. Measured in seconds since the Unix epoch.

expires_at

number

The time of when the Membership is set to go expired

string

required

The ID of the membership, which will look like mem_*************

license_key

string

The license key for the membership

manage_url

string

required

The URL for the customer to manage their membership on whop.com.

marketplace

boolean

Whether or not the membership was purchased through the whop marketplace.

metadata

object

The metadata for the membership

page_id

string

required

The ID of the page, which will look like page_*************

plan_id

string

required

The ID of the plan, which will look like plan_*************

product_id

string

required

The ID of the product, which will look like prod_*************

quantity

number

required

The quantity purchased

renewal_period_end

number

The UTC timestamp of when the Membership will end

renewal_period_start

number

The UTC timestamp of when the Membership will begin

status

enum<string>

required

The status of the membership

Available options:

trialing,

active,

past_due,

completed,

canceled,

expired,

unresolved

user_id

string

The ID of the user, which will look like user_*************

valid

boolean

required

Whether or not the membership is valid

Was this page helpful?

Retrieve a Membership Terminate a Membership

curl --request PATCH \
  --url https://api.whop.com/api/v5/company/memberships/{id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "metadata": {}
}'

{
  "affiliate_username": "<string>",
  "cancel_at_period_end": true,
  "checkout_id": "<string>",
  "company_buyer_id": "<string>",
  "created_at": 123,
  "expires_at": 123,
  "id": "<string>",
  "license_key": "<string>",
  "manage_url": "<string>",
  "marketplace": true,
  "metadata": {},
  "page_id": "<string>",
  "plan_id": "<string>",
  "product_id": "<string>",
  "quantity": 123,
  "renewal_period_end": 123,
  "renewal_period_start": 123,
  "status": "trialing",
  "user_id": "<string>",
  "valid": true
}