Get the cost breakdown of a workspace

curl -G https://api.prolific.com/api/v1/workspaces/workspace_id/cost/ \
     -H "Authorization: Token <token>" \
     -H "Content-Type: application/json" \
     -d reporting_period_start=reporting_period_start \
     -d reporting_period_end=reporting_period_end

{
  "current_study_cost": {
    "participant_cost": {
      "amount": 125000,
      "currency": "USD"
    },
    "fee_cost": {
      "amount": 15000,
      "currency": "USD"
    },
    "tax_cost": {
      "amount": 10000,
      "currency": "USD"
    }
  },
  "results": [
    {
      "id": "study_9f8b7c6d5e4a3b2c1d0e",
      "name": "Consumer Behavior Survey Q2",
      "status": "COMPLETED",
      "workspace": {
        "id": "workspace_123abc456def",
        "name": "Marketing Research Team"
      },
      "project": {
        "id": "project_789xyz123uvw",
        "name": "Q2 Consumer Insights"
      },
      "published_by": {
        "id": "user_456def789abc",
        "email": "jane.doe@researchco.com"
      },
      "published_at": "2024-01-15T09:30:00Z",
      "total_places": 500,
      "places_taken": 480,
      "current_cost": {
        "participant_cost": {
          "amount": 96000,
          "currency": "USD"
        },
        "fee_cost": {
          "amount": 12000,
          "currency": "USD"
        },
        "tax_cost": {
          "amount": 8000,
          "currency": "USD"
        }
      },
      "bonus_cost": {
        "participant_cost": {
          "amount": 2000,
          "currency": "USD"
        },
        "fee_cost": {
          "amount": 1500,
          "currency": "USD"
        },
        "tax_cost": {
          "amount": 1000,
          "currency": "USD"
        }
      },
      "adjustment_cost": {
        "participant_cost": {
          "amount": 1000,
          "currency": "USD"
        },
        "fee_cost": {
          "amount": 500,
          "currency": "USD"
        },
        "tax_cost": {
          "amount": 1000,
          "currency": "USD"
        }
      }
    }
  ],
  "meta": {
    "count": 1
  }
}

Returns the spend for a workspace over a reporting period. The response includes an aggregated current_study_cost and a paginated list of per-study cost rows.

Results can be filtered and sorted via query parameters; pass limit and offset to page through the study rows.

Enabling the feature

This endpoint is only available to select workspaces and will need enabling before it can be used.

Returns the spend for a workspace over a reporting period. The response includes an aggregated `current_study_cost` and a paginated list of per-study cost rows. Results can be filtered and sorted via query parameters; pass `limit` and `offset` to page through the study rows. ### Enabling the feature This endpoint is only available to select workspaces and will need enabling before it can be used.

Authentication

AuthorizationToken

The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings.

Your API token does not have an expiry date and carries full permission, so be sure to keep them secure.

If your token is leaked, delete it and create a new one directly in the app.

In your requests add Authorization header with the value Token <your token>.

The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings. Your API token does not have an expiry date and carries full permission, so be sure to keep them secure. If your token is leaked, delete it and create a new one directly in the app. In your requests add `Authorization` header with the value `Token <your token>`.

Path parameters

workspace_idstringRequired

Workspace id

Query parameters

reporting_period_startdatetimeRequired

Start of the reporting period (ISO 8601). Payments that settled at or after this timestamp are included.

reporting_period_enddatetimeRequired

End of the reporting period (ISO 8601). Payments that settled at or before this timestamp are included. Must be on or after reporting_period_start.

project_namelist of stringsOptional

Filter studies whose project name matches (case-insensitive substring). Pass a comma-separated list to match any of several names.

statuslist of enumsOptional

Filter studies by status. Pass a comma-separated list to match any of several statuses.

Allowed values:

published_by_emaillist of stringsOptional

Filter studies by the email of the researcher who published them. Pass a comma-separated list to match any of several emails.

orderingenumOptional

Sort order for the study rows.

limitintegerOptional0-100Defaults to 0

Maximum number of study rows to return (max 100). 0 returns all matching rows.

offsetintegerOptional>=0Defaults to 0

Number of study rows to skip before returning results.

Response

Success

current_study_costobject

Breakdown of a cost into its participant, fee and tax components.

resultslist of objects

metaobject

Errors

4XX

Client Request Error