API Documentation
Apps
- Overview
- Companies
- Experiences
- Members
- Memberships
- Products
- Payments
- Reviews
- Notifications
- Line Items
- App Connections
- Users
- Feed Content Items
- Inbound Webhooks
- Inbound Webhook Filters
- GETRetrieve the current app
- GETCheck Access
Company
- Overview
- Memberships
- Products
- Payments
- Reviews
- Users
- GETRetrieve the current company
Me
- Overview
- Memberships
- Products
- Payments
- Reviews
- Experiences
- Companies
- POSTCreate an OAuth Token
- GETRetrieve the current user
- GETList a User's social accounts
Chat
- Webhooks
List Payments
Returns a collection of payments
curl --request GET \
--url https://{defaultHost}/v5/company/payments \
--header 'Authorization: Bearer <token>'{
"pagination": {
"current_page": 123,
"total_pages": 123,
"next_page": 123,
"prev_page": 123,
"total_count": 123
},
"data": [
{
"id": "<string>",
"membership_id": "<string>",
"product_id": "<string>",
"user_id": "<string>",
"plan_id": "<string>",
"company_id": "<string>",
"line_item_id": 123,
"created_at": 123,
"paid_at": "<string>",
"refunded_at": "<string>",
"last_payment_attempt": "<string>",
"next_payment_attempt": "<string>",
"status": "draft",
"subtotal": 123,
"final_amount": 123,
"currency": "usd",
"refunded_amount": 123,
"payments_failed": 123,
"checkout_id": "<string>",
"card_brand": "<string>",
"card_last_4": "<string>",
"funding_method": "<string>",
"wallet_type": "apple_pay",
"calculated_statement_descriptor": "<string>",
"issuer_identification_number": "<string>",
"billing_usage_ids": [
"<string>"
],
"company_buyer_id": 123,
"billing_address": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"user_email": "<string>",
"user_username": "<string>",
"membership_metadata": "<any>",
"affiliate": "<any>"
}
]
}Authorizations
App API key for /v5/app and /v5/company endpoints
Query Parameters
An ID of a product to filter by, which will look like prod_*************
The page number to retrieve
The number of resources to return per page. There is a limit of 50 results per page.
Response
The ID of the payment, which will look like pay_*************
The ID of the membership, which will look like mem_*************
The ID of the product, which will look like prod_*************
The ID of the user, which will look like user_*************
The ID of the plan, which will look like plan_*************
The ID of the company, which will look like biz_*************
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.
The status of the payment
draft, open, paid, pending, uncollectible, unresolved, void The total amount paid by the User, including any discounts or taxes
The three letter currency the Payment was made in
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 The IDs of billing usages connected to this payment, which will look like bu_*************
The line item this receipt was purchased with. This is for in-app purchases.
The time at which the Payment was successful. Measured in seconds since the Unix epoch.
The time at which the Payment was refunded. Measured in seconds since the Unix epoch.
The UTC timestamp of the last time the Payment was attempted
The UTC timestamp of the next time the Payment will be attempted
The amount paid by the User, before any discounts or taxes
The amount that was refunded to the User (if applicable)
The number of times the Payment has failed
The ID of the checkout used to execute this payment, if applicable.
If the payment was made with a credit/debit card, the brand of the card.
The last 4 digits of the debit/credit card used to make the payment, if applicable.
The funding method of the payment, if applicable.
The wallet type of the payment, if applicable.
apple_pay, google_pay, paypal, venmo The statement descriptor that appears on the customer's bank statement for the payment, if applicable.
The IIN/BIN of the payment, if applicable.
The ID of the company that made the payment. (For example, they installed an app). Looks like biz_*************
The first and last name of the person
The first line of the address
The second line of the address
The city of the address
The state of the address
The postal code of the address
The country of the address
The email of the user that made the payment
The username of the user that made the payment
Was this page helpful?
curl --request GET \
--url https://{defaultHost}/v5/company/payments \
--header 'Authorization: Bearer <token>'{
"pagination": {
"current_page": 123,
"total_pages": 123,
"next_page": 123,
"prev_page": 123,
"total_count": 123
},
"data": [
{
"id": "<string>",
"membership_id": "<string>",
"product_id": "<string>",
"user_id": "<string>",
"plan_id": "<string>",
"company_id": "<string>",
"line_item_id": 123,
"created_at": 123,
"paid_at": "<string>",
"refunded_at": "<string>",
"last_payment_attempt": "<string>",
"next_payment_attempt": "<string>",
"status": "draft",
"subtotal": 123,
"final_amount": 123,
"currency": "usd",
"refunded_amount": 123,
"payments_failed": 123,
"checkout_id": "<string>",
"card_brand": "<string>",
"card_last_4": "<string>",
"funding_method": "<string>",
"wallet_type": "apple_pay",
"calculated_statement_descriptor": "<string>",
"issuer_identification_number": "<string>",
"billing_usage_ids": [
"<string>"
],
"company_buyer_id": 123,
"billing_address": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"user_email": "<string>",
"user_username": "<string>",
"membership_metadata": "<any>",
"affiliate": "<any>"
}
]
}