Payments
List Payments
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
Payments
List Payments
Returns a collection of payments
GET
/
v5
/
me
/
payments
curl --request GET \
--url https://{defaultHost}/v5/me/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": "<string>",
"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>"
}
]
}
Authorizations
User OAuth token for /v5/me endpoints
Query Parameters
An ID of a company to filter by, which will look like biz_*************
An ID of a product to filter by, which will look like prod_*************
An ID of a line item to filter by, which will look like li_*************
Response
200 - application/json
payments retrieved
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://{defaultHost}/v5/me/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": "<string>",
"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>"
}
]
}