List Payments

GET

payments

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 ***************************

Query Parameters

page

integer

default: 1

The page number to retrieve

per

integer

default: 10

The number of resources to return per page. There is a limit of 50 results per page.

status

enum<string>

The status of the Payment

Available options:

draft,

open,

paid,

uncollectible,

void

membership_id

string

The Membership this Payment part of. By default this will just be the ID of the Membership, but you can expand it to get more information about the Membership by passing [membership] in the expand parameter.

expand

enum<string>[]

Whether or not to expand the User, Membership, Plan, or Product on the returned Payment. Pass an array with each object(s) you want to expand, e.g. [product, plan, membership, user]

Available options:

product,

membership,

plan,

user

Response

200 - application/json

pagination

object

Pagination model

data

object[]

data.id

string

The ID of the Payment, which will look like pay_*************

data.product

string

The Product this Payment is for. By default this will just be the ID of the Product, but you can expand it to get more information about the Product by passing [product] in the expand parameter.

data.membership

string

data.affiliate_reward

number

The amount paid to the Affiliate for this Payment

data.plan

string

The Plan this Payment is under. By default this will just be the ID of the Plan, but you can expand it to get more information about the Plan by passing [plan] in the expand parameter.

data.user

string

The User who made the Payment. By default this will just be the ID of the User, but you can expand it to get more information about the User by passing [user] in the expand parameter.

data.final_amount

number

The total amount paid by the User, including any discounts or taxes

data.subtotal

number

The amount paid by the User, before any discounts or taxes

data.currency

string

The three letter currency the Payment was made in

data.last4

string

The last four digits of the credit/debit card used to make the Payment

data.payments_failed

integer

The number of times the Payment has failed

data.payment_processor

string

Which platform was used to process the Payment

data.refunded_amount

number

The amount that was refunded to the User (if applicable)

data.status

string

The status of the Payment

data.crypto_tx_hash

string

The transaction hash for the Payment if it was made with a cryptocurrency

data.wallet_address

string

The crypto wallet address use to make this Payment

data.created_at

integer

The time at which the Payment was created. Measured in seconds since the Unix epoch. Does not necessarily reflect the time the Payment was successful.

data.paid_at

integer

The time at which the Payment was successfully paid at. Measured in seconds since the Unix epoch.

data.refunded_at

integer

The UTC timestamp of the date the Payment was refunded (if applicable)

data.last_payment_attempt

integer

The UTC timestamp of the last time the Payment was attempted

data.next_payment_attempt

integer

The UTC timestamp of the next time the Payment will be attempted

data.access_pass

string

Access Pass has been deprecated for Product. Please use product instead and do not use access_pass.

Was this page helpful?

Retrieve Member Retrieve a Payment

API Documentation

Memberships

Products

Plans

Experiences

Checkout Sessions

Companies

Members

Payments

Promo Codes

Reviews

Webhooks

Headers

Query Parameters

Response