Show Study cost | Prolific API

Returns cost information about the study. Default behaviour is to return cost at the time of the request, but projected cost can be requested via a query parameter.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path parameters

idstringRequired

Study id

Query parameters

is_projectedbooleanOptionalDefaults to false

Return the projected cost of the study

Response

Return the total cost for the study

rewardsobject or null

bonusesobject or null

_linksmap from strings to any or null

1	{
2	"rewards": {
3	"rewards": {
4	"amount": 100,
5	"currency": "USD"
6	},
7	"fees": {
8	"amount": 100,
9	"currency": "USD"
10	},
11	"tax": {
12	"amount": 100,
13	"currency": "USD"
14	}
15	},
16	"bonuses": {
17	"rewards": {
18	"amount": 100,
19	"currency": "USD"
20	},
21	"fees": {
22	"amount": 100,
23	"currency": "USD"
24	},
25	"tax": {
26	"amount": 100,
27	"currency": "USD"
28	}
29	},
30	"_links": {}
31	}

1	curl https://api.prolific.com/api/v1/studies/id/cost/ \
2	-H "Authorization: Token <token>"

Authentication

Path parameters

Query parameters

Response

Errors