Skip to content

Paid members, with their counts by status

GET
/api/v1/workspaces/{workspace}/earn/members
curl --request GET \
--url 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/earn/members?status=with_access&period=month&source=campaign&since=7d&page=1&pageSize=8' \
--header 'Authorization: Bearer <token>'

Permission: earn:view

Amounts are in minor units, before tax. Test paid members show only with test=true.

workspace
required

Workspace slug

string
/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

status
string
default: with_access
Allowed values: with_access paying trialing past_due cancels_soon complimentary gift ended
q

Name, email, billing email or Stripe customer ID

string
<= 200 characters

Name, email, billing email or Stripe customer ID

tier

Tier id

string

Tier id

period
string
Allowed values: month year ""
source
string
Allowed values: campaign automation page offer website import gift grant direct ""
offer

An offer’s label (FALL26)

string
<= 60 characters

An offer’s label (FALL26)

since
string
Allowed values: 7d 30d 90d 1y ""
campaign

Campaign id: paid members credited to it

string

Campaign id: paid members credited to it

before

Paid members since before this date

string format: date

Paid members since before this date

test
boolean
all
boolean
page
integer format: int64
default: 1 >= 1
pageSize
integer format: int64
default: 8 >= 1 <= 100

OK

Media typeapplication/json
object
accessRule
required
string
Allowed values: keep end
campaigns
required
Array<object>
object
id
required
string
name
required
string
canExport
required
boolean
canImport
required
boolean
canManage
required
boolean
canSeeNames
required
boolean
connected
required
boolean
counts
required
object
cancelsSoon
required
integer format: int64
complimentary
required
integer format: int64
ended
required
integer format: int64
gift
required
integer format: int64
pastDue
required
integer format: int64
paying
required
integer format: int64
trialing
required
integer format: int64
withAccess
required
integer format: int64
currency
required
string
exportHelpers
required
Array<string>
helpers
required
Array<string>
items
required
Array<object>
object
accessPaused
required
boolean
amountCents
required
integer format: int64
cancelAt
string format: date-time
cancelReason
string
contactId
required
string
currency
required
string
discount
object
amountCents
required
integer format: int64
duration
string
endsAt
string format: date-time
label
required
string
percent
number format: double
email
required
string
endReason
string
giftFrom
string
giftMonths
integer format: int64
hidden
required
boolean
id
required
string
kind
required
string
Allowed values: stripe complimentary gift
legacy
required
boolean
ltvCents
required
integer format: int64
name
required
string
next
required
string
Allowed values: renews ends retries trial_ends no_end ended
nextAt
string format: date-time
period
required
string
Allowed values: month year ""
periodShown
required
boolean
refundedCents
required
integer format: int64
since
required
string format: date-time
source
required
object
campaignId
string
grantedBy
string
importId
string
kind
required
string
Allowed values: campaign automation page offer website import gift grant direct ""
label
required
string
platform
string
reason
string
status
required
string
Allowed values: trialing active past_due canceled complimentary gift
test
required
boolean
tier
required
string
tierId
string
tierName
required
string
movedAt
string format: date-time
mrrCents
required
integer format: int64
offers
required
Array<string>
platforms
required
Array<string>
testMembers
required
integer format: int64
testShown
required
integer format: int64
tiers
required
Array<object>
object
id
required
string
name
required
string
total
required
integer format: int64
upgradeHost
required
string
upgradeUrl
required
string

Example

{
"accessRule": "keep",
"items": [
{
"kind": "stripe",
"next": "renews",
"period": "month",
"source": {
"kind": "campaign"
},
"status": "trialing"
}
]
}

Error

Media typeapplication/problem+json
object
code

Stable error code, e.g. permission_denied

string
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object>
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

helpers

Members who hold the missing permission

Array<string>
instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
meta
object
key
additional properties
permission

The missing permission key

string
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example

{
"detail": "Property foo is required but is missing.",
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}