DELETE
/
v2
/
checkout_sessions
/
{id}
curl --request DELETE \
  --url https://api.whop.com/api/v2/checkout_sessions/{id}
{
  "id": "<string>",
  "redirect_url": "<string>",
  "affiliate_code": "<string>",
  "metadata": {},
  "plan_id": "<string>",
  "purchase_url": "<string>"
}

Headers

Authorization
string

Your API key, which can be found on the Whop Business Dashboard. You must prepend your key with the word 'Bearer', which will look like Bearer ***************************

Path Parameters

id
string
required

The ID of the session, which will look like ch_*************

Response

204 - application/json
id
string

The ID of the session, which will look like ch_*************

redirect_url
string

The URL the user will be navigated to after successfully completing a checkout with this session

affiliate_code
string

The code to apply as the affiliate for the transaction. Codes are a User object's username field.

metadata
object

The metadata that will be attached to the Membership upon successful purchase.

plan_id
string

The ID of the plan that the checkout session is associated with, which will look like plan_*************

purchase_url
string

The URL that the customer can use to purchase with this checkout session.