Memberships

Retrieve Membership

Changed on

Retrieves a membership by ID or license key. Accessible to the account and to the membership's own user.

get/memberships/{id}

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/memberships/{id}
  • Auth: HTTP bearer

Response

membership retrieved with its recorded phone number

billing_period_daysinteger nullable required

Number of days between recurring charges. null for non-renewing memberships or memberships with multiple renewal schedules.

cancel_at_period_endboolean required

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

cancel_option'too_expensive' | 'switching' | 'missing_features' | 'technical_issues' | 'bad_experience' | 'unused' | 'other' | 'testing' | 'null' nullable required

The category the member picked for why they canceled. null when no category was picked.

canceled_atstring nullable required

When cancellation was requested, or when the membership was canceled if no request time is recorded, as an ISO 8601 timestamp. null when neither is recorded.

cancellation_reasonstring nullable required

Free-text explanation provided when canceling. null when no reason was provided.

collection_method'charge_automatically' | 'send_invoice' | 'null' nullable required

How renewals are collected. charge_automatically charges the saved payment method each period; send_invoice emails the buyer an invoice each period. null when not set.

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.

current_period_startstring nullable required

When the current billing period started, as an ISO 8601 timestamp. null when no billing period is recorded.

expires_atstring nullable required

When access ends for a membership with a fixed expiration, as an ISO 8601 timestamp. null when the membership has no expiration, such as a renewing membership.

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.

manage_urlstring nullable required

URL where the buyer can sign in to manage billing. null without a member record or unless the caller is the buyer or has member:manage on the account.

member_idstring nullable required

The buyer's member record on the account, prefixed mber_. null when the membership has no member record, such as an unclaimed membership.

metadataobject required

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

most_recent_action'canceled_on' | 'finished_split_pay_at' | 'canceling_on' | 'ending_on' | 'renewing_on' | 'past_due' | 'next_payment_attempt' | 'paused_at' | 'trial_ends_at' | 'unresolved_at' | 'trial_canceling_on' | 'null' nullable required

The membership's latest lifecycle event, such as renewing_on or canceled_on. Pair it with most_recent_action_at. null when none is recorded.

most_recent_action_atstring nullable required

When most_recent_action happened or is scheduled to happen, as an ISO 8601 timestamp. A future time for upcoming events such as renewing_on. null when no action is recorded.

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 variant the buyer purchased, prefixed plan_.

product_idstring required

The product this membership grants access to, prefixed prod_.

promo_code_idstring nullable required

The promo code discounting this membership, prefixed promo_. null when none is applied. Set at checkout or by Apply Promo Code to Membership.

split_pay_current_paymentsinteger nullable required

Paid installments counted so far on a split pay membership. null when the membership is not on split pay, or before its first installment is counted.

split_pay_required_paymentsinteger nullable required

Installment payments required before the membership stops billing. null when the membership is not on split pay.

status'trialing' | 'active' | 'past_due' | 'completed' | 'canceled' | 'expired' | 'unresolved' required

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.

updated_atstring required

When the membership was last changed, as an ISO 8601 timestamp. Reflects the most recent change to the membership itself, so you can reconcile against webhook retries, replays, and backfills.

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"
  },
  "affiliate": {
    "applies_to_payments": "first_payment",
    "commission_amount": {
      "amount": "-1234.56",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "commission_type": "flat_fee"
  },
  "billing_period_days": 30,
  "cancel_at_period_end": true,
  "cancel_option": "too_expensive",
  "canceled_at": "2026-01-01T12:00:00.000Z",
  "cancellation_reason": "Too expensive",
  "collection_method": "send_invoice",
  "created_at": "2026-01-01T12:00:00.000Z",
  "current_period_end": "2026-01-01T12:00:00.000Z",
  "current_period_start": "2026-01-01T12:00:00.000Z",
  "expires_at": "2026-01-01T12:00:00.000Z",
  "feedback_option": {
    "label": "The wash club costs more than I can spend"
  },
  "id": "mem_xxxxxxxxxxxxxx",
  "initial_price": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "license_key": "WHOP-XXXX-XXXX-XXXX",
  "manage_url": "https://whop.com/billing/manage/mber_xxxxxxxxxxxxxx",
  "member": {
    "access_level": "customer",
    "last_accessed_at": "2026-01-01T12:00:00.000Z",
    "position": 1767268800000
  },
  "member_id": "mber_xxxxxxxxxxxxxx",
  "metadata": {},
  "most_recent_action": "renewing_on",
  "most_recent_action_at": "2026-01-01T12:00:00.000Z",
  "phone_number": "+xxxxxxxxxxx",
  "plan_id": "plan_xxxxxxxxxxxxxx",
  "product": {
    "id": "prod_xxxxxxxxxxxxxx",
    "logo_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "title": "Ceramic Coating Package"
  },
  "product_id": "prod_xxxxxxxxxxxxxx",
  "promo_code_id": "promo_xxxxxxxxxxxxxx",
  "renewal_price": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "status": "active",
  "updated_at": "2026-01-01T12:00:00.000Z",
  "user_id": "user_xxxxxxxxxxxxxx"
}

Changes

  • 507636677fe9Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 8d734102c0b6Revision changes
    • info

      added the required property to the response with the status