API ReferenceapiaffiliatesGET /v1/affiliates/me/payouts

GET /v1/affiliates/me/payouts

Service: affiliates · operationId: (none)

Earnings summary + per-period payout breakdown for the current affiliate. Used by the affiliate-facing dashboard.

Required scopes

(no scope declared — review service config)

Responses

200 Per-period payouts and totals

{
  "type": "object",
  "properties": {
    "summary": {
      "type": "object",
      "properties": {
        "currency": {
          "type": "string"
        },
        "pending_cents": {
          "type": "string"
        },
        "paid_this_period_cents": {
          "type": "string"
        },
        "lifetime_paid_cents": {
          "type": "string"
        },
        "next_payout_date": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "currency",
        "pending_cents",
        "paid_this_period_cents",
        "lifetime_paid_cents",
        "next_payout_date"
      ]
    },
    "payouts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "period_start": {
            "type": "string"
          },
          "period_end": {
            "type": "string"
          },
          "currency": {
            "type": "string"
          },
          "gross_amount_cents": {
            "type": "string"
          },
          "reversal_amount_cents": {
            "type": "string"
          },
          "amount_cents": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "paid_at": {
            "type": [
              "string",
              "null"
            ]
          },
          "created_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "period_start",
          "period_end",
          "currency",
          "gross_amount_cents",
          "reversal_amount_cents",
          "amount_cents",
          "status",
          "paid_at",
          "created_at"
        ]
      }
    }
  },
  "required": [
    "summary",
    "payouts"
  ]
}

404 Affiliate profile not found

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

Example

curl -X GET https://affiliates.platform.loop.health/v1/affiliates/me/payouts \
  -H "Authorization: Bearer $ACCESS_TOKEN"