Create payment

curl --request POST \
  --url https://api.whop.com/api/v1/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_id": "biz_xxxxxxxxxxxxxx",
  "member_id": "mber_xxxxxxxxxxxxx",
  "payment_method_id": "pmt_xxxxxxxxxxxxxx",
  "plan": {
    "application_fee_amount": 6.9,
    "billing_period": 42,
    "description": "<string>",
    "expiration_days": 42,
    "force_create_new_plan": true,
    "initial_price": 6.9,
    "internal_notes": "<string>",
    "product": {
      "external_identifier": "<string>",
      "title": "<string>",
      "collect_shipping_address": true,
      "custom_statement_descriptor": "<string>",
      "description": "<string>",
      "global_affiliate_percentage": 6.9,
      "headline": "<string>",
      "product_tax_code_id": "ptc_xxxxxxxxxxxxxx",
      "redirect_purchase_url": "<string>",
      "route": "<string>"
    },
    "product_id": "prod_xxxxxxxxxxxxx",
    "renewal_price": 6.9,
    "title": "<string>",
    "trial_period_days": 42
  },
  "metadata": {},
  "promo_code_id": "promo_xxxxxxxxxxxx"
}
'

import requests

url = "https://api.whop.com/api/v1/payments"

payload = {
    "company_id": "biz_xxxxxxxxxxxxxx",
    "member_id": "mber_xxxxxxxxxxxxx",
    "payment_method_id": "pmt_xxxxxxxxxxxxxx",
    "plan": {
        "application_fee_amount": 6.9,
        "billing_period": 42,
        "description": "<string>",
        "expiration_days": 42,
        "force_create_new_plan": True,
        "initial_price": 6.9,
        "internal_notes": "<string>",
        "product": {
            "external_identifier": "<string>",
            "title": "<string>",
            "collect_shipping_address": True,
            "custom_statement_descriptor": "<string>",
            "description": "<string>",
            "global_affiliate_percentage": 6.9,
            "headline": "<string>",
            "product_tax_code_id": "ptc_xxxxxxxxxxxxxx",
            "redirect_purchase_url": "<string>",
            "route": "<string>"
        },
        "product_id": "prod_xxxxxxxxxxxxx",
        "renewal_price": 6.9,
        "title": "<string>",
        "trial_period_days": 42
    },
    "metadata": {},
    "promo_code_id": "promo_xxxxxxxxxxxx"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    company_id: 'biz_xxxxxxxxxxxxxx',
    member_id: 'mber_xxxxxxxxxxxxx',
    payment_method_id: 'pmt_xxxxxxxxxxxxxx',
    plan: {
      application_fee_amount: 6.9,
      billing_period: 42,
      description: '<string>',
      expiration_days: 42,
      force_create_new_plan: true,
      initial_price: 6.9,
      internal_notes: '<string>',
      product: {
        external_identifier: '<string>',
        title: '<string>',
        collect_shipping_address: true,
        custom_statement_descriptor: '<string>',
        description: '<string>',
        global_affiliate_percentage: 6.9,
        headline: '<string>',
        product_tax_code_id: 'ptc_xxxxxxxxxxxxxx',
        redirect_purchase_url: '<string>',
        route: '<string>'
      },
      product_id: 'prod_xxxxxxxxxxxxx',
      renewal_price: 6.9,
      title: '<string>',
      trial_period_days: 42
    },
    metadata: {},
    promo_code_id: 'promo_xxxxxxxxxxxx'
  })
};

fetch('https://api.whop.com/api/v1/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'company_id' => 'biz_xxxxxxxxxxxxxx',
    'member_id' => 'mber_xxxxxxxxxxxxx',
    'payment_method_id' => 'pmt_xxxxxxxxxxxxxx',
    'plan' => [
        'application_fee_amount' => 6.9,
        'billing_period' => 42,
        'description' => '<string>',
        'expiration_days' => 42,
        'force_create_new_plan' => true,
        'initial_price' => 6.9,
        'internal_notes' => '<string>',
        'product' => [
                'external_identifier' => '<string>',
                'title' => '<string>',
                'collect_shipping_address' => true,
                'custom_statement_descriptor' => '<string>',
                'description' => '<string>',
                'global_affiliate_percentage' => 6.9,
                'headline' => '<string>',
                'product_tax_code_id' => 'ptc_xxxxxxxxxxxxxx',
                'redirect_purchase_url' => '<string>',
                'route' => '<string>'
        ],
        'product_id' => 'prod_xxxxxxxxxxxxx',
        'renewal_price' => 6.9,
        'title' => '<string>',
        'trial_period_days' => 42
    ],
    'metadata' => [
        
    ],
    'promo_code_id' => 'promo_xxxxxxxxxxxx'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/payments"

	payload := strings.NewReader("{\n  \"company_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"member_id\": \"mber_xxxxxxxxxxxxx\",\n  \"payment_method_id\": \"pmt_xxxxxxxxxxxxxx\",\n  \"plan\": {\n    \"application_fee_amount\": 6.9,\n    \"billing_period\": 42,\n    \"description\": \"<string>\",\n    \"expiration_days\": 42,\n    \"force_create_new_plan\": true,\n    \"initial_price\": 6.9,\n    \"internal_notes\": \"<string>\",\n    \"product\": {\n      \"external_identifier\": \"<string>\",\n      \"title\": \"<string>\",\n      \"collect_shipping_address\": true,\n      \"custom_statement_descriptor\": \"<string>\",\n      \"description\": \"<string>\",\n      \"global_affiliate_percentage\": 6.9,\n      \"headline\": \"<string>\",\n      \"product_tax_code_id\": \"ptc_xxxxxxxxxxxxxx\",\n      \"redirect_purchase_url\": \"<string>\",\n      \"route\": \"<string>\"\n    },\n    \"product_id\": \"prod_xxxxxxxxxxxxx\",\n    \"renewal_price\": 6.9,\n    \"title\": \"<string>\",\n    \"trial_period_days\": 42\n  },\n  \"metadata\": {},\n  \"promo_code_id\": \"promo_xxxxxxxxxxxx\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.whop.com/api/v1/payments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"company_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"member_id\": \"mber_xxxxxxxxxxxxx\",\n  \"payment_method_id\": \"pmt_xxxxxxxxxxxxxx\",\n  \"plan\": {\n    \"application_fee_amount\": 6.9,\n    \"billing_period\": 42,\n    \"description\": \"<string>\",\n    \"expiration_days\": 42,\n    \"force_create_new_plan\": true,\n    \"initial_price\": 6.9,\n    \"internal_notes\": \"<string>\",\n    \"product\": {\n      \"external_identifier\": \"<string>\",\n      \"title\": \"<string>\",\n      \"collect_shipping_address\": true,\n      \"custom_statement_descriptor\": \"<string>\",\n      \"description\": \"<string>\",\n      \"global_affiliate_percentage\": 6.9,\n      \"headline\": \"<string>\",\n      \"product_tax_code_id\": \"ptc_xxxxxxxxxxxxxx\",\n      \"redirect_purchase_url\": \"<string>\",\n      \"route\": \"<string>\"\n    },\n    \"product_id\": \"prod_xxxxxxxxxxxxx\",\n    \"renewal_price\": 6.9,\n    \"title\": \"<string>\",\n    \"trial_period_days\": 42\n  },\n  \"metadata\": {},\n  \"promo_code_id\": \"promo_xxxxxxxxxxxx\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"company_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"member_id\": \"mber_xxxxxxxxxxxxx\",\n  \"payment_method_id\": \"pmt_xxxxxxxxxxxxxx\",\n  \"plan\": {\n    \"application_fee_amount\": 6.9,\n    \"billing_period\": 42,\n    \"description\": \"<string>\",\n    \"expiration_days\": 42,\n    \"force_create_new_plan\": true,\n    \"initial_price\": 6.9,\n    \"internal_notes\": \"<string>\",\n    \"product\": {\n      \"external_identifier\": \"<string>\",\n      \"title\": \"<string>\",\n      \"collect_shipping_address\": true,\n      \"custom_statement_descriptor\": \"<string>\",\n      \"description\": \"<string>\",\n      \"global_affiliate_percentage\": 6.9,\n      \"headline\": \"<string>\",\n      \"product_tax_code_id\": \"ptc_xxxxxxxxxxxxxx\",\n      \"redirect_purchase_url\": \"<string>\",\n      \"route\": \"<string>\"\n    },\n    \"product_id\": \"prod_xxxxxxxxxxxxx\",\n    \"renewal_price\": 6.9,\n    \"title\": \"<string>\",\n    \"trial_period_days\": 42\n  },\n  \"metadata\": {},\n  \"promo_code_id\": \"promo_xxxxxxxxxxxx\"\n}"

response = http.request(request)
puts response.read_body

{
  "amount_after_fees": 6.9,
  "application_fee": {
    "amount": 6.9,
    "amount_captured": 6.9,
    "amount_refunded": 6.9,
    "created_at": "2023-12-01T05:00:00.401Z",
    "id": "apfee_xxxxxxxxxxxx"
  },
  "auto_refunded": true,
  "billing_address": {
    "city": "<string>",
    "country": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "name": "<string>",
    "postal_code": "<string>",
    "state": "<string>"
  },
  "card_last4": "4242",
  "checkout_configuration_id": "<string>",
  "company": {
    "id": "biz_xxxxxxxxxxxxxx",
    "route": "<string>",
    "title": "<string>"
  },
  "created_at": "2023-12-01T05:00:00.401Z",
  "dispute_alerted_at": "2023-12-01T05:00:00.401Z",
  "disputes": [
    {
      "amount": 6.9,
      "editable": true,
      "id": "dspt_xxxxxxxxxxxxx",
      "needs_response_by": "2023-12-01T05:00:00.401Z",
      "notes": "Customer used the product for 3 months before disputing.",
      "reason": "Product Not Received"
    }
  ],
  "failure_message": "<string>",
  "financing_installments_count": 42,
  "financing_transactions": [
    {
      "amount": 6.9,
      "created_at": "2023-12-01T05:00:00.401Z",
      "id": "ptx_xxxxxxxxxxxxxx"
    }
  ],
  "id": "pay_xxxxxxxxxxxxxx",
  "last_payment_attempt": "2023-12-01T05:00:00.401Z",
  "member": {
    "id": "<string>",
    "phone": "<string>"
  },
  "membership": {
    "id": "mem_xxxxxxxxxxxxxx",
    "phone_number": "<string>"
  },
  "metadata": {},
  "next_payment_attempt": "2023-12-01T05:00:00.401Z",
  "paid_at": "2023-12-01T05:00:00.401Z",
  "payment_method": {
    "card": {
      "exp_month": 42,
      "exp_year": 42,
      "last4": "4242"
    },
    "created_at": "2023-12-01T05:00:00.401Z",
    "id": "payt_xxxxxxxxxxxxx"
  },
  "payments_failed": 42,
  "plan": {
    "id": "plan_xxxxxxxxxxxxx",
    "internal_notes": "<string>",
    "metadata": {}
  },
  "product": {
    "id": "prod_xxxxxxxxxxxxx",
    "metadata": {},
    "route": "pickaxe-analytics",
    "title": "Pickaxe Analytics"
  },
  "promo_code": {
    "amount_off": 6.9,
    "code": "<string>",
    "id": "promo_xxxxxxxxxxxx",
    "number_of_intervals": 42
  },
  "refundable": true,
  "refunded_amount": 6.9,
  "refunded_at": "2023-12-01T05:00:00.401Z",
  "refunds": [
    {
      "amount": 6.9,
      "created_at": "2023-12-01T05:00:00.401Z",
      "id": "rf_xxxxxxxxxxxxxxx"
    }
  ],
  "resolutions": [
    {
      "customer_appealed": true,
      "customer_response_actions": [],
      "due_date": "2023-12-01T05:00:00.401Z",
      "id": "reso_xxxxxxxxxxxxx",
      "merchant_appealed": true,
      "merchant_response_actions": [],
      "platform_response_actions": []
    }
  ],
  "retryable": true,
  "risk_score": 42,
  "risk_signals": {},
  "settlement_amount": 6.9,
  "settlement_exchange_rate": 6.9,
  "shipping_address": {
    "city": "<string>",
    "country": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "name": "<string>",
    "postal_code": "<string>",
    "state": "<string>"
  },
  "subtotal": 6.9,
  "tax_amount": 6.9,
  "tax_refunded_amount": 6.9,
  "three_ds_verified": true,
  "total": 6.9,
  "updated_at": "2023-12-01T05:00:00.401Z",
  "usd_total": 6.9,
  "user": {
    "email": "john.doe@example.com",
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  },
  "voidable": true
}

{
  "error": {
    "code": "parameter_missing",
    "message": "Missing required parameter: amount.",
    "param": "amount",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "message": "Invalid or missing API key",
    "type": "unauthorized"
  }
}

{
  "error": {
    "message": "You do not have permission to access this resource",
    "type": "forbidden"
  }
}

{
  "error": {
    "message": "Resource not found",
    "type": "not_found"
  }
}

{
  "error": null
}

{
  "error": null
}

{
  "error": {
    "message": "An unexpected error occurred",
    "type": "internal_server_error"
  }
}

Payments

Create payment

Charge an existing member off-session using one of their stored payment methods. You can provide an existing plan, or create a new one in-line. This endpoint will respond with a payment object immediately, but the payment is processed asynchronously in the background. Use webhooks to be notified when the payment succeeds or fails.

Required permissions:

payment:charge
plan:create
access_pass:create
access_pass:update
plan:basic:read
access_pass:basic:read
member:email:read
member:basic:read
member:phone:read
promo_code:basic:read
payment:dispute:read
payment:resolution_center_case:read

POST

payments

Create payment

curl --request POST \
  --url https://api.whop.com/api/v1/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_id": "biz_xxxxxxxxxxxxxx",
  "member_id": "mber_xxxxxxxxxxxxx",
  "payment_method_id": "pmt_xxxxxxxxxxxxxx",
  "plan": {
    "application_fee_amount": 6.9,
    "billing_period": 42,
    "description": "<string>",
    "expiration_days": 42,
    "force_create_new_plan": true,
    "initial_price": 6.9,
    "internal_notes": "<string>",
    "product": {
      "external_identifier": "<string>",
      "title": "<string>",
      "collect_shipping_address": true,
      "custom_statement_descriptor": "<string>",
      "description": "<string>",
      "global_affiliate_percentage": 6.9,
      "headline": "<string>",
      "product_tax_code_id": "ptc_xxxxxxxxxxxxxx",
      "redirect_purchase_url": "<string>",
      "route": "<string>"
    },
    "product_id": "prod_xxxxxxxxxxxxx",
    "renewal_price": 6.9,
    "title": "<string>",
    "trial_period_days": 42
  },
  "metadata": {},
  "promo_code_id": "promo_xxxxxxxxxxxx"
}
'

import requests

url = "https://api.whop.com/api/v1/payments"

payload = {
    "company_id": "biz_xxxxxxxxxxxxxx",
    "member_id": "mber_xxxxxxxxxxxxx",
    "payment_method_id": "pmt_xxxxxxxxxxxxxx",
    "plan": {
        "application_fee_amount": 6.9,
        "billing_period": 42,
        "description": "<string>",
        "expiration_days": 42,
        "force_create_new_plan": True,
        "initial_price": 6.9,
        "internal_notes": "<string>",
        "product": {
            "external_identifier": "<string>",
            "title": "<string>",
            "collect_shipping_address": True,
            "custom_statement_descriptor": "<string>",
            "description": "<string>",
            "global_affiliate_percentage": 6.9,
            "headline": "<string>",
            "product_tax_code_id": "ptc_xxxxxxxxxxxxxx",
            "redirect_purchase_url": "<string>",
            "route": "<string>"
        },
        "product_id": "prod_xxxxxxxxxxxxx",
        "renewal_price": 6.9,
        "title": "<string>",
        "trial_period_days": 42
    },
    "metadata": {},
    "promo_code_id": "promo_xxxxxxxxxxxx"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    company_id: 'biz_xxxxxxxxxxxxxx',
    member_id: 'mber_xxxxxxxxxxxxx',
    payment_method_id: 'pmt_xxxxxxxxxxxxxx',
    plan: {
      application_fee_amount: 6.9,
      billing_period: 42,
      description: '<string>',
      expiration_days: 42,
      force_create_new_plan: true,
      initial_price: 6.9,
      internal_notes: '<string>',
      product: {
        external_identifier: '<string>',
        title: '<string>',
        collect_shipping_address: true,
        custom_statement_descriptor: '<string>',
        description: '<string>',
        global_affiliate_percentage: 6.9,
        headline: '<string>',
        product_tax_code_id: 'ptc_xxxxxxxxxxxxxx',
        redirect_purchase_url: '<string>',
        route: '<string>'
      },
      product_id: 'prod_xxxxxxxxxxxxx',
      renewal_price: 6.9,
      title: '<string>',
      trial_period_days: 42
    },
    metadata: {},
    promo_code_id: 'promo_xxxxxxxxxxxx'
  })
};

fetch('https://api.whop.com/api/v1/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'company_id' => 'biz_xxxxxxxxxxxxxx',
    'member_id' => 'mber_xxxxxxxxxxxxx',
    'payment_method_id' => 'pmt_xxxxxxxxxxxxxx',
    'plan' => [
        'application_fee_amount' => 6.9,
        'billing_period' => 42,
        'description' => '<string>',
        'expiration_days' => 42,
        'force_create_new_plan' => true,
        'initial_price' => 6.9,
        'internal_notes' => '<string>',
        'product' => [
                'external_identifier' => '<string>',
                'title' => '<string>',
                'collect_shipping_address' => true,
                'custom_statement_descriptor' => '<string>',
                'description' => '<string>',
                'global_affiliate_percentage' => 6.9,
                'headline' => '<string>',
                'product_tax_code_id' => 'ptc_xxxxxxxxxxxxxx',
                'redirect_purchase_url' => '<string>',
                'route' => '<string>'
        ],
        'product_id' => 'prod_xxxxxxxxxxxxx',
        'renewal_price' => 6.9,
        'title' => '<string>',
        'trial_period_days' => 42
    ],
    'metadata' => [
        
    ],
    'promo_code_id' => 'promo_xxxxxxxxxxxx'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/payments"

	payload := strings.NewReader("{\n  \"company_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"member_id\": \"mber_xxxxxxxxxxxxx\",\n  \"payment_method_id\": \"pmt_xxxxxxxxxxxxxx\",\n  \"plan\": {\n    \"application_fee_amount\": 6.9,\n    \"billing_period\": 42,\n    \"description\": \"<string>\",\n    \"expiration_days\": 42,\n    \"force_create_new_plan\": true,\n    \"initial_price\": 6.9,\n    \"internal_notes\": \"<string>\",\n    \"product\": {\n      \"external_identifier\": \"<string>\",\n      \"title\": \"<string>\",\n      \"collect_shipping_address\": true,\n      \"custom_statement_descriptor\": \"<string>\",\n      \"description\": \"<string>\",\n      \"global_affiliate_percentage\": 6.9,\n      \"headline\": \"<string>\",\n      \"product_tax_code_id\": \"ptc_xxxxxxxxxxxxxx\",\n      \"redirect_purchase_url\": \"<string>\",\n      \"route\": \"<string>\"\n    },\n    \"product_id\": \"prod_xxxxxxxxxxxxx\",\n    \"renewal_price\": 6.9,\n    \"title\": \"<string>\",\n    \"trial_period_days\": 42\n  },\n  \"metadata\": {},\n  \"promo_code_id\": \"promo_xxxxxxxxxxxx\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.whop.com/api/v1/payments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"company_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"member_id\": \"mber_xxxxxxxxxxxxx\",\n  \"payment_method_id\": \"pmt_xxxxxxxxxxxxxx\",\n  \"plan\": {\n    \"application_fee_amount\": 6.9,\n    \"billing_period\": 42,\n    \"description\": \"<string>\",\n    \"expiration_days\": 42,\n    \"force_create_new_plan\": true,\n    \"initial_price\": 6.9,\n    \"internal_notes\": \"<string>\",\n    \"product\": {\n      \"external_identifier\": \"<string>\",\n      \"title\": \"<string>\",\n      \"collect_shipping_address\": true,\n      \"custom_statement_descriptor\": \"<string>\",\n      \"description\": \"<string>\",\n      \"global_affiliate_percentage\": 6.9,\n      \"headline\": \"<string>\",\n      \"product_tax_code_id\": \"ptc_xxxxxxxxxxxxxx\",\n      \"redirect_purchase_url\": \"<string>\",\n      \"route\": \"<string>\"\n    },\n    \"product_id\": \"prod_xxxxxxxxxxxxx\",\n    \"renewal_price\": 6.9,\n    \"title\": \"<string>\",\n    \"trial_period_days\": 42\n  },\n  \"metadata\": {},\n  \"promo_code_id\": \"promo_xxxxxxxxxxxx\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"company_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"member_id\": \"mber_xxxxxxxxxxxxx\",\n  \"payment_method_id\": \"pmt_xxxxxxxxxxxxxx\",\n  \"plan\": {\n    \"application_fee_amount\": 6.9,\n    \"billing_period\": 42,\n    \"description\": \"<string>\",\n    \"expiration_days\": 42,\n    \"force_create_new_plan\": true,\n    \"initial_price\": 6.9,\n    \"internal_notes\": \"<string>\",\n    \"product\": {\n      \"external_identifier\": \"<string>\",\n      \"title\": \"<string>\",\n      \"collect_shipping_address\": true,\n      \"custom_statement_descriptor\": \"<string>\",\n      \"description\": \"<string>\",\n      \"global_affiliate_percentage\": 6.9,\n      \"headline\": \"<string>\",\n      \"product_tax_code_id\": \"ptc_xxxxxxxxxxxxxx\",\n      \"redirect_purchase_url\": \"<string>\",\n      \"route\": \"<string>\"\n    },\n    \"product_id\": \"prod_xxxxxxxxxxxxx\",\n    \"renewal_price\": 6.9,\n    \"title\": \"<string>\",\n    \"trial_period_days\": 42\n  },\n  \"metadata\": {},\n  \"promo_code_id\": \"promo_xxxxxxxxxxxx\"\n}"

response = http.request(request)
puts response.read_body

{
  "amount_after_fees": 6.9,
  "application_fee": {
    "amount": 6.9,
    "amount_captured": 6.9,
    "amount_refunded": 6.9,
    "created_at": "2023-12-01T05:00:00.401Z",
    "id": "apfee_xxxxxxxxxxxx"
  },
  "auto_refunded": true,
  "billing_address": {
    "city": "<string>",
    "country": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "name": "<string>",
    "postal_code": "<string>",
    "state": "<string>"
  },
  "card_last4": "4242",
  "checkout_configuration_id": "<string>",
  "company": {
    "id": "biz_xxxxxxxxxxxxxx",
    "route": "<string>",
    "title": "<string>"
  },
  "created_at": "2023-12-01T05:00:00.401Z",
  "dispute_alerted_at": "2023-12-01T05:00:00.401Z",
  "disputes": [
    {
      "amount": 6.9,
      "editable": true,
      "id": "dspt_xxxxxxxxxxxxx",
      "needs_response_by": "2023-12-01T05:00:00.401Z",
      "notes": "Customer used the product for 3 months before disputing.",
      "reason": "Product Not Received"
    }
  ],
  "failure_message": "<string>",
  "financing_installments_count": 42,
  "financing_transactions": [
    {
      "amount": 6.9,
      "created_at": "2023-12-01T05:00:00.401Z",
      "id": "ptx_xxxxxxxxxxxxxx"
    }
  ],
  "id": "pay_xxxxxxxxxxxxxx",
  "last_payment_attempt": "2023-12-01T05:00:00.401Z",
  "member": {
    "id": "<string>",
    "phone": "<string>"
  },
  "membership": {
    "id": "mem_xxxxxxxxxxxxxx",
    "phone_number": "<string>"
  },
  "metadata": {},
  "next_payment_attempt": "2023-12-01T05:00:00.401Z",
  "paid_at": "2023-12-01T05:00:00.401Z",
  "payment_method": {
    "card": {
      "exp_month": 42,
      "exp_year": 42,
      "last4": "4242"
    },
    "created_at": "2023-12-01T05:00:00.401Z",
    "id": "payt_xxxxxxxxxxxxx"
  },
  "payments_failed": 42,
  "plan": {
    "id": "plan_xxxxxxxxxxxxx",
    "internal_notes": "<string>",
    "metadata": {}
  },
  "product": {
    "id": "prod_xxxxxxxxxxxxx",
    "metadata": {},
    "route": "pickaxe-analytics",
    "title": "Pickaxe Analytics"
  },
  "promo_code": {
    "amount_off": 6.9,
    "code": "<string>",
    "id": "promo_xxxxxxxxxxxx",
    "number_of_intervals": 42
  },
  "refundable": true,
  "refunded_amount": 6.9,
  "refunded_at": "2023-12-01T05:00:00.401Z",
  "refunds": [
    {
      "amount": 6.9,
      "created_at": "2023-12-01T05:00:00.401Z",
      "id": "rf_xxxxxxxxxxxxxxx"
    }
  ],
  "resolutions": [
    {
      "customer_appealed": true,
      "customer_response_actions": [],
      "due_date": "2023-12-01T05:00:00.401Z",
      "id": "reso_xxxxxxxxxxxxx",
      "merchant_appealed": true,
      "merchant_response_actions": [],
      "platform_response_actions": []
    }
  ],
  "retryable": true,
  "risk_score": 42,
  "risk_signals": {},
  "settlement_amount": 6.9,
  "settlement_exchange_rate": 6.9,
  "shipping_address": {
    "city": "<string>",
    "country": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "name": "<string>",
    "postal_code": "<string>",
    "state": "<string>"
  },
  "subtotal": 6.9,
  "tax_amount": 6.9,
  "tax_refunded_amount": 6.9,
  "three_ds_verified": true,
  "total": 6.9,
  "updated_at": "2023-12-01T05:00:00.401Z",
  "usd_total": 6.9,
  "user": {
    "email": "john.doe@example.com",
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  },
  "voidable": true
}

{
  "error": {
    "code": "parameter_missing",
    "message": "Missing required parameter: amount.",
    "param": "amount",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "message": "Invalid or missing API key",
    "type": "unauthorized"
  }
}

{
  "error": {
    "message": "You do not have permission to access this resource",
    "type": "forbidden"
  }
}

{
  "error": {
    "message": "Resource not found",
    "type": "not_found"
  }
}

{
  "error": null
}

{
  "error": null
}

{
  "error": {
    "message": "An unexpected error occurred",
    "type": "internal_server_error"
  }
}

Authorizations

Authorization

string

header

required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Body

application/json

CreatePaymentInputWithPlan
CreatePaymentInputWithPlanId

Autogenerated input type of CreatePayment

company_id

string

required

The ID of the company to create the payment for.

Example:

"biz_xxxxxxxxxxxxxx"

member_id

string

required

The ID of the member to create the payment for.

Example:

"mber_xxxxxxxxxxxxx"

payment_method_id

string

required

The ID of the payment method to use for the payment. It must be connected to the Member being charged.

Example:

"pmt_xxxxxxxxxxxxxx"

plan

object

required

Pass this object to create a new plan for this payment

Show child attributes

metadata

object | null

Custom metadata to attach to the payment.

The ID of an active promo code to apply to this payment. The promo code must belong to the company and be valid for the plan being purchased. The plan must be attached to a product — promo codes are not eligible for one-off purchases.

Example:

"promo_xxxxxxxxxxxx"

Response

A successful response

A payment represents a completed or attempted charge. Payments track the amount, status, currency, and payment method used.

amount_after_fees

number

required

How much the payment is for after fees

Example:

6.9

application_fee

object | null

required

The application fee charged on this payment.

Show child attributes

auto_refunded

boolean

required

Whether this payment was auto refunded or not

billing_address

object | null

required

The address of the user who made the payment.

Show child attributes

billing_reason

enum<string> | null

required

The machine-readable reason this charge was created, such as initial subscription purchase, renewal cycle, or one-time payment.

Available options:

subscription_create,

subscription_cycle,

subscription_update,

one_time,

manual,

subscription

card_brand

enum<string> | null

required

Card network reported by the processor (e.g., 'visa', 'mastercard', 'amex'). Present only when the payment method type is 'card'.

Available options:

mastercard,

visa,

amex,

discover,

unionpay,

jcb,

diners,

link,

troy,

visadankort,

visabancontact,

china_union_pay,

rupay,

jcbrupay,

elo,

maestro,

tarjeta_naranja,

cirrus,

nspk_mir,

verve,

ebt,

private_label,

local_brand,

uatp,

wexcard,

uzcard,

meeza,

hrg_store_card,

girocard,

fuel_card,

dankort,

carnet,

atm_card,

china_union_payuzcard,

codensa,

cabal,

hipercard,

jcblankapay,

cmi,

aura,

unknown

card_last4

string | null

required

The last four digits of the card used to make this payment. Null if the payment was not made with a card.

Example:

"4242"

checkout_configuration_id

string | null

required

The ID of the checkout session/configuration that produced this payment, if any. Use this to map payments back to the checkout configuration that created them.

company

object | null

required

The company for the payment.

Show child attributes

created_at

string<date-time>

required

The datetime the payment was created.

Example:

"2023-12-01T05:00:00.401Z"

currency

enum<string>

required

The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').

Available options:

usd,

sgd,

inr,

aud,

brl,

cad,

dkk,

eur,

nok,

gbp,

sek,

chf,

hkd,

huf,

jpy,

mxn,

myr,

pln,

czk,

nzd,

aed,

eth,

ape,

cop,

ron,

thb,

bgn,

idr,

dop,

php,

try,

krw,

twd,

vnd,

pkr,

clp,

uyu,

ars,

zar,

dzd,

tnd,

mad,

kes,

kwd,

jod,

all,

xcd,

amd,

bsd,

bhd,

bob,

bam,

khr,

crc,

xof,

egp,

etb,

gmd,

ghs,

gtq,

gyd,

ils,

jmd,

mop,

mga,

mur,

mdl,

mnt,

nad,

ngn,

mkd,

omr,

pyg,

pen,

qar,

rwf,

sar,

rsd,

lkr,

tzs,

ttd,

uzs,

rub,

btc,

cny,

usdt,

kzt,

awg,

whop_usd,

xau

dispute_alerted_at

string<date-time> | null

required

When an alert came in that this transaction will be disputed

Example:

"2023-12-01T05:00:00.401Z"

disputes

object[] | null

required

The disputes attached to this payment. Null if the actor in context does not have the payment:dispute:read permission.

Show child attributes

failure_message

string | null

required

If the payment failed, the reason for the failure.

financing_installments_count

integer | null

required

The number of financing installments for the payment. Present if the payment is a financing payment (e.g. Splitit, Klarna, etc.).

Example:

42

financing_transactions

object[]

required

The financing transactions attached to this payment. Present if the payment is a financing payment (e.g. Splitit, Klarna, etc.).

Show child attributes

string

required

The unique identifier for the payment.

Example:

"pay_xxxxxxxxxxxxxx"

last_payment_attempt

string<date-time> | null

required

The time of the last payment attempt.

Example:

"2023-12-01T05:00:00.401Z"

member

object | null

required

The member attached to this payment.

Show child attributes

membership

object | null

required

The membership attached to this payment.

Show child attributes

metadata

object | null

required

The custom metadata stored on this payment. This will be copied over to the checkout configuration for which this payment was made

next_payment_attempt

string<date-time> | null

required

The time of the next schedule payment retry.

Example:

"2023-12-01T05:00:00.401Z"

paid_at

string<date-time> | null

required

The time at which this payment was successfully collected. Null if the payment has not yet succeeded. As a Unix timestamp.

Example:

"2023-12-01T05:00:00.401Z"

payment_method

object | null

required

The tokenized payment method reference used for this payment. Null if no token was used.

Show child attributes

payment_method_type

enum<string> | null

required

The type of payment instrument used for this payment (e.g., card, Cash App, iDEAL, Klarna, crypto). Null when the processor does not supply a type.

Available options:

acss_debit,

affirm,

afterpay_clearpay,

alipay,

alma,

amazon_pay,

apple,

apple_pay,

au_bank_transfer,

au_becs_debit,

bacs_debit,

bancolombia,

bancontact,

billie,

bizum,

blik,

boleto,

bre_b,

ca_bank_transfer,

capchase_pay,

card,

card_installments_three,

card_installments_six,

card_installments_twelve,

cashapp,

claritypay,

coinbase,

crypto,

custom,

customer_balance,

demo_pay,

efecty,

eps,

eu_bank_transfer,

fpx,

gb_bank_transfer,

giropay,

google_pay,

gopay,

grabpay,

id_bank_transfer,

ideal,

interac,

kakao_pay,

klarna,

klarna_pay_now,

konbini,

kr_card,

kr_market,

kriya,

kueski,

link,

mb_way,

m_pesa,

mercado_pago,

mobilepay,

mondu,

multibanco,

naver_pay,

nequi,

netbanking,

ng_bank,

ng_bank_transfer,

ng_card,

ng_market,

ng_ussd,

ng_wallet,

nz_bank_account,

oxxo,

p24,

pago_efectivo,

pse,

pay_by_bank,

payco,

paynow,

paypal,

paypay,

payto,

pix,

platform_balance,

promptpay,

qris,

rechnung,

revolut_pay,

samsung_pay,

satispay,

scalapay,

sencillito,

sepa_debit,

sequra,

servipag,

sezzle,

shop_pay,

shopeepay,

sofort,

south_korea_market,

spei,

splitit,

sunbit,

swish,

tamara,

twint,

upi,

us_bank_account,

us_bank_transfer,

venmo,

vipps,

webpay,

wechat_pay,

yape,

zip,

coinflow,

unknown

payments_failed

integer | null

required

The number of failed payment attempts for the payment.

Example:

42

plan

object | null

required

The plan attached to this payment.

Show child attributes

product

object | null

required

The product this payment was made for

Show child attributes

The promo code used for this payment.

Show child attributes

refundable

boolean

required

True only for payments that are paid, have not been fully refunded, and were processed by a payment processor that allows refunds.

refunded_amount

number | null

required

The payment refund amount(if applicable).

Example:

6.9

refunded_at

string<date-time> | null

required

When the payment was refunded (if applicable).

Example:

"2023-12-01T05:00:00.401Z"

refunds

object[]

required

The refunds issued against this payment, newest first, including failed and canceled refund attempts. Limited to the 100 most recent.

Show child attributes

resolutions

object[] | null

required

The resolution center cases opened by the customer on this payment. Null if the actor in context does not have the payment:resolution_center_case:read permission.

Show child attributes

retryable

boolean

required

True when the payment status is open and its membership is in one of the retry-eligible states (active, trialing, completed, or past_due); otherwise false. Used to decide if Whop can attempt the charge again.

risk_score

integer | null

required

Whop's in-house fraud risk score for this payment, from 0 (lowest risk) to 100 (highest risk). Null when the payment has not been scored or scoring has not yet completed.

Example:

42

risk_signals

object | null

required

A curated set of factors behind the risk score, grouped by category (business transaction history, buyer, device). Each entry has a key, human-readable label, category, and value. Null when there is no risk assessment for this payment.

settlement_amount

number

required

The total amount charged to the customer for this payment, including taxes and after any discounts. In the currency specified by the currency field.

Example:

6.9

settlement_currency

enum<string>

required

The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').

Available options:

usd,

sgd,

inr,

aud,

brl,

cad,

dkk,

eur,

nok,

gbp,

sek,

chf,

hkd,

huf,

jpy,

mxn,

myr,

pln,

czk,

nzd,

aed,

eth,

ape,

cop,

ron,

thb,

bgn,

idr,

dop,

php,

try,

krw,

twd,

vnd,

pkr,

clp,

uyu,

ars,

zar,

dzd,

tnd,

mad,

kes,

kwd,

jod,

all,

xcd,

amd,

bsd,

bhd,

bob,

bam,

khr,

crc,

xof,

egp,

etb,

gmd,

ghs,

gtq,

gyd,

ils,

jmd,

mop,

mga,

mur,

mdl,

mnt,

nad,

ngn,

mkd,

omr,

pyg,

pen,

qar,

rwf,

sar,

rsd,

lkr,

tzs,

ttd,

uzs,

rub,

btc,

cny,

usdt,

kzt,

awg,

whop_usd,

xau

settlement_exchange_rate

number | null

required

Deprecated. Always returns null.

Example:

6.9

shipping_address

object | null

required

The shipping address provided by the customer for physical goods. Null if no shipping address was collected.

Show child attributes

status

enum<string> | null

required

The current lifecycle state of this payment (e.g., 'draft', 'open', 'paid', 'void').

Available options:

draft,

open,

paid,

pending,

uncollectible,

unresolved,

void

substatus

enum<string>

required

The friendly status of the payment.

Available options:

succeeded,

pending,

failed,

past_due,

canceled,

price_too_low,

uncollectible,

refunded,

auto_refunded,

partially_refunded,

dispute_warning,

dispute_needs_response,

dispute_warning_needs_response,

resolution_needs_response,

dispute_under_review,

dispute_warning_under_review,

resolution_under_review,

dispute_won,

dispute_warning_closed,

resolution_won,

dispute_lost,

dispute_closed,

resolution_lost,

drafted,

incomplete,

unresolved,

open_dispute,

open_resolution

subtotal

number | null

required

The subtotal to show to the creator (excluding buyer fees).

Example:

6.9

tax_amount

number | null

required

The calculated amount of the sales/VAT tax (if applicable).

Example:

6.9

tax_behavior

enum<string> | null

required

The type of tax inclusivity applied to the payment, for determining whether the tax is included in the final price, or paid on top.

Available options:

exclusive,

inclusive,

unspecified,

unable_to_collect

tax_refunded_amount

number | null

required

The amount of tax that has been refunded (if applicable).

Example:

6.9

three_ds_verified

boolean

required

Whether 3D Secure authentication was completed for this payment.

total

number | null

required

The total to show to the creator (excluding buyer fees).

Example:

6.9

updated_at

string<date-time>

required

The datetime the payment was last updated.

Example:

"2023-12-01T05:00:00.401Z"

usd_total

number | null

required

The total in USD to show to the creator (excluding buyer fees).

Example:

6.9

user

object | null

required

The user that made this payment.

Show child attributes

voidable

boolean

required

True when the payment is tied to a membership in past_due, the payment status is open, and the processor allows voiding payments; otherwise false.

List payments

Retrieve payment

⌘I

Introduction

Developer

Ads

CRM

AI

Identity

Bounties

Cards

Engagement

Payins

Courses

Payouts

Stats

Create payment

Authorizations

Body

Response