Create payment

Authorizations

Authorization

string

header

required

The app API key from an app from the /dashboard/developer page

Body

application/json

CreatePaymentInputWithPlan
CreatePaymentInputWithPlanId

Parameters for CreatePayment 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

plan.currency

enum<string>

required

The respective currency identifier for the plan.

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

plan.billing_period

integer | null

The interval at which the plan charges (renewal plans).

Example:

42

plan.description

string | null

The description of the plan.

plan.expiration_days

integer | null

The interval at which the plan charges (expiration plans).

Example:

42

plan.force_create_new_plan

boolean | null

Whether to force the creation of a new plan even if one with the same attributes already exists.

plan.initial_price

number | null

An additional amount charged upon first purchase.

Example:

6.9

plan.internal_notes

string | null

A personal description or notes section for the business.

plan.plan_type

enum<string> | null

Indicates if the plan is a one time payment or recurring.

Available options:

renewal,

one_time

plan.product

object

Pass this object to create a new product for this plan. We will use the product external identifier to find or create an existing product.

Show child attributes

plan.product.external_identifier

string

required

A unique ID used to find or create a product. When provided during creation, we will look for an existing product with this external identifier — if found, it will be updated; otherwise, a new product will be created.

plan.product.title

string

required

The title of the product.

plan.product.business_type

enum<string> | null

The business type of the product.

Available options:

education_program,

coaching,

software,

paid_group,

newsletter,

agency,

physical_products,

brick_and_mortar,

events,

coaching_and_courses,

other,

saas,

course,

community

plan.product.collect_shipping_address

boolean | null

Whether or not to collect shipping information at checkout from the customer.

plan.product.custom_statement_descriptor

string | null

The custom statement descriptor for the product i.e. WHOP*SPORTS, must be between 5 and 22 characters, contain at least one letter, and not contain any of the following characters: <, >, , ', "

plan.product.description

string | null

A written description of the product.

plan.product.global_affiliate_percentage

number | null

The percentage of the revenue that goes to the global affiliate program.

Example:

6.9

plan.product.global_affiliate_status

enum<string> | null

The status of the global affiliate program for this product.

Available options:

enabled,

disabled

plan.product.headline

string | null

The headline of the product.

plan.product.industry_type

enum<string> | null

The industry type of the product.

Available options:

trading,

sports_betting,

reselling,

fitness,

amazon_fba,

real_estate,

kindle_book_publishing,

dating,

agencies,

health_and_wellness,

social_media,

sales,

business,

ecommerce,

video_games,

home_services,

ai,

public_speaking,

personal_finance,

careers,

travel,

clipping,

spirituality,

vas,

personal_development,

software,

other,

marketing_agency,

sales_agency,

ai_agency,

design_agency,

coaching_agency,

development_agency,

recruiting_agency,

customer_support_agency,

clipping_agency,

clothing,

supplements,

beauty_and_personal_care,

fitness_gear,

accessories,

home_goods,

electronics_and_gadgets,

food_and_beverages,

gym,

restaurant,

retail_store,

coffee_shop,

salon_spa,

medical_dentist_office,

hotel_lodging,

auto_repair_shop,

masterminds,

webinars,

bootcamps,

convention,

concerts,

meetups,

parties

plan.product.product_tax_code_id

string | null

The ID of the product tax code to apply to this product.

Example:

"ptc_xxxxxxxxxxxxxx"

plan.product.redirect_purchase_url

string | null

The URL to redirect the customer to after a purchase.

plan.product.route

string | null

The route of the product.

plan.product.visibility

enum<string> | null

This product will/will not be displayed publicly - default hidden.

Available options:

visible,

hidden,

archived,

quick_link

plan.product_id

string | null

The product the plan is related to. Either this or product is required.

Example:

"prod_xxxxxxxxxxxxx"

plan.renewal_price

number | null

The amount the customer is charged every billing period.

Example:

6.9

plan.title

string | null

The title of the plan. This will be visible on the product page to customers.

plan.trial_period_days

integer | null

The number of free trial days added before a renewal plan.

Example:

42

plan.visibility

enum<string> | null

Shows or hides the plan from public/business view.

Available options:

visible,

hidden,

archived,

quick_link

Response

A successful response

An object representing a receipt for a membership.

string

required

The payment ID

Example:

"pay_xxxxxxxxxxxxxx"

status

enum<string> | null

required

The current state of the payment.

Available options:

draft,

open,

paid,

pending,

uncollectible,

unresolved,

void

substatus

enum<string>

required

The friendly status of the payment.

Available options:

auto_refunded,

refunded,

partially_refunded,

dispute_warning,

open_resolution,

open_dispute,

failed,

price_too_low,

succeeded,

drafted,

uncollectible,

unresolved,

past_due,

pending,

incomplete,

canceled

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.

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.

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.

created_at

string<date-time>

required

The datetime the payment was created

Example:

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

paid_at

string<date-time> | null

required

The datetime the payment was paid

Example:

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

last_payment_attempt

string<date-time> | null

required

The time of the last payment attempt.

Example:

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

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"

refunded_at

string<date-time> | null

required

When the payment was refunded (if applicable).

Example:

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

plan

object

required

The plan attached to this payment.

Show child attributes

plan.id

string

required

The internal ID of the plan.

Example:

"plan_xxxxxxxxxxxxx"

product

object

required

The product this payment was made for

Show child attributes

product.id

string

required

The internal ID of the public product.

Example:

"prod_xxxxxxxxxxxxx"

product.title

string

required

The title of the product. Use for Whop 4.0.

product.route

string

required

The route of the product.

user

object

required

The user that made this payment.

Show child attributes

user.id

string

required

The internal ID of the user.

Example:

"user_xxxxxxxxxxxxx"

user.name

string | null

required

The name of the user from their Whop account.

Example:

"John Doe"

user.username

string

required

The username of the user from their Whop account.

Example:

"johndoe42"

user.email

string | null

required

The email of the user

Example:

"[email protected]"

membership

object

required

The membership attached to this payment.

Show child attributes

membership.id

string

required

The internal ID of the membership.

Example:

"mem_xxxxxxxxxxxxxx"

membership.status

enum<string>

required

The state of the membership.

Available options:

trialing,

active,

past_due,

completed,

canceled,

expired,

unresolved,

drafted

member

object

required

The member attached to this payment.

Show child attributes

member.id

string

required

The ID of the member

member.phone

string | null

required

The phone number for the member, if available.

payment_method

object

required

The payment method used for the payment, if available.

Show child attributes

payment_method.id

string

required

The ID of the payment method

Example:

"payt_xxxxxxxxxxxxx"

payment_method.created_at

string<date-time>

required

The date and time the payment method was created

Example:

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

payment_method.payment_method_type

enum<string>

required

The payment method type of the payment method

Available options:

acss_debit,

affirm,

afterpay_clearpay,

alipay,

alma,

amazon_pay,

apple_pay,

au_becs_debit,

bacs_debit,

bancontact,

billie,

blik,

boleto,

card,

cashapp,

crypto,

eps,

fpx,

giropay,

google_pay,

grabpay,

ideal,

kakao_pay,

klarna,

konbini,

kr_card,

link,

mobilepay,

multibanco,

naver_pay,

nz_bank_account,

oxxo,

p24,

pay_by_bank,

payco,

paynow,

pix,

promptpay,

revolut_pay,

samsung_pay,

satispay,

sepa_debit,

sofort,

swish,

twint,

us_bank_account,

wechat_pay,

zip,

bizum,

capchase_pay,

kriya,

mondu,

ng_wallet,

paypay,

sequra,

scalapay,

vipps,

custom,

customer_balance,

gopay,

mb_way,

ng_bank,

ng_bank_transfer,

ng_card,

ng_market,

ng_ussd,

paypal,

payto,

qris,

rechnung,

south_korea_market,

kr_market,

shopeepay,

upi,

sunbit,

netbanking,

id_bank_transfer,

demo_pay,

shop_pay,

sezzle,

coinbase,

splitit,

platform_balance,

apple,

venmo,

unknown

payment_method.card

object

required

The card data associated with the payment method, if its a debit or credit card.

Show child attributes

payment_method.card.brand

enum<string> | null

required

Card brand (e.g., VISA, MASTERCARD).

Available options:

mastercard,

visa,

amex,

discover,

unionpay,

jcb,

diners,

link,

troy,

visadankort,

visabancontact,

china_union_pay,

rupay,

jcbrupay,

elo,

maestro,

unknown

payment_method.card.last4

string | null

required

Last four digits of the card.

payment_method.card.exp_month

integer | null

required

Card expiration month, like 03 for March.

Example:

42

payment_method.card.exp_year

integer | null

required

Card expiration year, like 27 for 2027.

Example:

42

company

object

required

The company for the payment.

Show child attributes

company.id

string

required

The ID of the company

Example:

"biz_xxxxxxxxxxxxxx"

company.title

string

required

The written name of the company.

company.route

string

required

The slug/route of the company on the Whop site.

The promo code used for this payment.

Show child attributes

The ID of the promo.

Example:

"promo_xxxxxxxxxxxx"

The specific code used to apply the promo at checkout.

The amount off (% or flat amount) for the promo.

Example:

6.9

The monetary currency of the promo code.

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

The type (% or flat amount) of the promo.

Available options:

percentage,

flat_amount

The number of months the promo is applied for.

Example:

42

currency

enum<string> | null

required

The currency of the payment.

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

total

number | null

required

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

Example:

6.9

subtotal

number | null

required

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

Example:

6.9

usd_total

number | null

required

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

Example:

6.9

refunded_amount

number | null

required

The payment refund amount(if applicable).

Example:

6.9

auto_refunded

boolean

required

Whether this payment was auto refunded or not

amount_after_fees

number

required

How much the payment is for after fees

Example:

6.9

card_brand

enum<string> | null

required

Card network reported by the processor (for example visa, mastercard, amex). Present only when the underlying 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,

unknown

card_last4

string | null

required

The last 4 digits of the card used to make the payment.

billing_address

object

required

The address of the user who made the payment.

Show child attributes

billing_address.name

string | null

required

The name of the customer.

billing_address.line1

string | null

required

The line 1 of the address.

billing_address.line2

string | null

required

The line 2 of the address.

billing_address.city

string | null

required

The city of the address.

billing_address.state

string | null

required

The state of the address.

billing_address.postal_code

string | null

required

The postal code of the address.

billing_address.country

string | null

required

The country of the address.

payment_method_type

enum<string> | null

required

Machine-readable identifier for the payment method used on the payment. Examples include card, cashapp ..., local methods such as ideal, sofort, ... BNPL options like klarna, affirm, ..., or crypto. Returns null when the processor does not supply a type.

Available options:

acss_debit,

affirm,

afterpay_clearpay,

alipay,

alma,

amazon_pay,

apple_pay,

au_becs_debit,

bacs_debit,

bancontact,

billie,

blik,

boleto,

card,

cashapp,

crypto,

eps,

fpx,

giropay,

google_pay,

grabpay,

ideal,

kakao_pay,

klarna,

konbini,

kr_card,

link,

mobilepay,

multibanco,

naver_pay,

nz_bank_account,

oxxo,

p24,

pay_by_bank,

payco,

paynow,

pix,

promptpay,

revolut_pay,

samsung_pay,

satispay,

sepa_debit,

sofort,

swish,

twint,

us_bank_account,

wechat_pay,

zip,

bizum,

capchase_pay,

kriya,

mondu,

ng_wallet,

paypay,

sequra,

scalapay,

vipps,

custom,

customer_balance,

gopay,

mb_way,

ng_bank,

ng_bank_transfer,

ng_card,

ng_market,

ng_ussd,

paypal,

payto,

qris,

rechnung,

south_korea_market,

kr_market,

shopeepay,

upi,

sunbit,

netbanking,

id_bank_transfer,

demo_pay,

shop_pay,

sezzle,

coinbase,

splitit,

platform_balance,

apple,

venmo,

unknown

billing_reason

enum<string> | null

required

The reason for the charge.

Available options:

subscription_create,

subscription_cycle,

subscription_update,

one_time,

manual,

subscription

failure_message

string | null

required

If the payment failed, the reason for the failure.

metadata

object

required

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

Introduction

Payins

Payouts

Identity

CRM

Engagement

Courses

Developer

Authorizations

Body

Response