Response
A successful response
cancel_at_period_endboolean
Whether this membership is set to cancel at the end of the current billing cycle. Only applies to memberships with a recurring plan.
cancel_optionenum or null
The category selected for why the member canceled (e.g. too_expensive, switching, missing_features).
canceled_atdatetime or null
The time the customer initiated cancellation of this membership. As a Unix timestamp. Null if the membership has not been canceled.
cancellation_reasonstring or null
Free-text explanation provided by the customer when canceling. Null if the customer did not provide a reason.
checkout_configuration_idstring or null
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.
companyobject
The company this membership belongs to.
created_atdatetime
The datetime the membership was created.
currencyenum or null
The three-letter ISO currency code for this membership’s billing. Null if the membership is free.
custom_field_responseslist of objects
The customer's responses to custom checkout questions configured on the product at the time of purchase.
idstring
The unique identifier for the membership.
joined_atdatetime or null
The time the user first joined the company associated with this membership. As a Unix timestamp. Null if the member record does not exist.
license_keystring or null
The software license key associated with this membership. Only present if the product includes a Whop Software Licensing experience. Null otherwise.
manage_urlstring or null
The URL where the customer can view and manage this membership, including cancellation and plan changes. Null if no member record exists.
memberobject or null
The member record linking the user to the company for this membership. Null if the member record has not been created yet.
metadatamap from strings to any or null
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_pausedboolean
Whether recurring payment collection for this membership is temporarily paused by the company.
planobject
The plan the customer purchased to create this membership.
productobject
The product this membership grants access to.
promo_codeobject or null
The promotional code currently applied to this membership's billing. Null if no promo code is active.
renewal_period_enddatetime or null
The end of the current billing period for this recurring membership. As a Unix timestamp. Null if the membership is not recurring.
renewal_period_startdatetime or null
The start of the current billing period for this recurring membership. As a Unix timestamp. Null if the membership is not recurring.
statusenum
The current lifecycle status of the membership (e.g., active, trialing, past_due, canceled, expired, completed).
updated_atdatetime
The datetime the membership was last updated.
userobject or null
The user who owns this membership. Null if the user account has been deleted.
