Get payments

Get all user payment invoices paginated

URL:  [POST] /api/v1/profile/payments

curl -X 'GET' \
  'BASE_URL/api/v1/profile/payments \
  -H 'accept: application/json' \
  -H 'Authorization: bearer YOUR_AUTH_TOKEN
  -H 'Content-Type: application/json'  

Response JSON

  "code": 200,
  "message": "Customer payments retrieved successfully.",
  "data": {
    "items": [
        "amount_due_usd": 15.0,
        "amount_refunded_usd": 0.0,
        "id": 9705,
        "reference": "1014c5ec-fa05-4d63-8479-5412a87603f5-0",
        "subscription_log": {
          "is_expired": true,
          "is_period_expired": true,
          "id": 979,
          "subscription_plan": {
            "id": 2,
            "plan_name": "Weekly (basic test)",
            "recurring_type": "week",
            "amount": 15,
            "is_default": false,
            "subscription_product": {
              "id": 3,
              "name": "basic (watermark free)"
          "start_date": "2023-03-15T00:00:00+02:00",
          "expected_end_date": "2023-03-22T00:00:00+02:00",
          "end_date": "2023-03-15T00:00:00+02:00",
          "cancel_at_period_end": false
        "status": "paid",
        "currency": "usd",
        "period_start": "2023-03-15T13:11:50+02:00",
        "total": 1500,
        "amount_due": 1500,
        "created_at": "2023-03-15T15:11:59+02:00",
        "updated_at": "2023-03-15T15:11:59+02:00"
    "total_items": 7,
    "page_limit": 10,
    "has_previous_page": false,
    "has_next_page": false,
    "total_pages": 1,
    "current_page": 1

Request parameters

Parameter nameValueDescriptionOptional 
idintInvoice ID
amount_due_usdfloatAmount paidNo
amount_refunded_usdfloatAmount refundedNo
referencestringInvoice reference unique numberNo
subscription_logobjectSubscription object, refer to change subscription API for its detailsNo
statusstringStatus of the invoice (paid/open)No
currencystringUSD alwaysNo
totalintegerTotal amount in USDNo
amount_dueintegerAmount due in USDNo
period_startdatetimePeriod start dateNo
created_atdatetimeCreation dateNo
updated_atintUpdate dateNo

Powered by BetterDocs