GET
/
v5
/
company
/
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

​
Authorization
string
header
required

App API key for /v5/app and /v5/company endpoints

Query Parameters

​
product_id
string

An ID of a product to filter by, which will look like prod_*************

​
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.

Response

200 - application/json

payments retrieved

The response is of type object.