Skip to content
ReputeCastReputeCast Docs

Earn › Overview: MRR and its movement, paid members, trials, conversions, cancellations and attribution

GET
/api/v1/workspaces/{workspace}/earn/revenue
curl --request GET \
  --url 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/earn/revenue?period=30d' \
  --header 'Authorization: Bearer <token>'

Permission: earn:view

MRR is the monthly value of every Active and Past due subscription, after discounts, before tax, live mode only; a yearly price counts as a twelfth.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace
required

Workspace slug

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

Workspace slug

Query Parameters

Section titled “Query Parameters”
period

The last 30 days, 90 days or 12 months

string
default: 30d
Allowed values: 30d 90d 12m

The last 30 days, 90 days or 12 months

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
account
required
string
activity
required
Array<object>
object
accessPaused
required
boolean
amountCents
integer format: int64
at
required
string format: date-time
canceledBy
string
contactId
required
string
currency
required
string
data
required
object
key
additional properties
endsAt
string format: date-time
firstName
required
string
kind
required
string
Allowed values: payment_failed refunded cancel_scheduled offer_applied gift_redeemed subscribed
name
required
string
offerCents
integer format: int64
offerEndsAt
string format: date-time
period
required
string
priceCents
required
integer format: int64
sawOffer
string
source
required
string
sourceKind
required
string
tier
required
string
canEdit
required
boolean
canManage
required
boolean
canPayments
required
boolean
canSponsors
required
boolean
cancellations
required
object
continued
required
integer format: int64
kept
required
integer format: int64
keptOffer
string
keptTier
string
offerId
string
reasons
required
Array<object>
object
count
required
integer format: int64
reason
required
string
undecided
required
integer format: int64
visits
required
integer format: int64
chart
required
object
deltaCents
required
integer format: int64
deltaPct
number format: double
endCents
required
integer format: int64
historyUntil
string format: date-time
marks
required
Array<object>
object
at
required
string format: date-time
kind
required
string
Allowed values: moved offer
n
required
integer format: int64
name
required
string
points
required
Array<object>
object
at
required
string format: date-time
history
required
boolean
mrrCents
required
integer format: int64
since
required
string format: date-time
startCents
required
integer format: int64
connectedAt
string format: date-time
conversions
required
object
byEmail
required
Array<object>
object
byEmail
required
integer format: int64
byToken
required
integer format: int64
count
required
integer format: int64
id
required
string
kind
required
string
Allowed values: campaign automation
name
required
string
valueCents
required
integer format: int64
count
required
integer format: int64
currency
required
string
latest
required
Array<object>
object
at
required
string format: date-time
campaignId
string
credited
required
string
currency
required
string
matched
required
string
Allowed values: click_token email none
valueCents
required
integer format: int64
name
string
otherCurrency
required
integer format: int64
sender
string
since
string format: date-time
total
required
integer format: int64
typicalCents
integer format: int64
uncredited
required
object
cents
required
integer format: int64
count
required
integer format: int64
valueCents
required
integer format: int64
currency
required
string
dataSince
string format: date-time
failed
required
Array<string>
freeToPaid
required
object
all
required
integer format: int64
direct
required
integer format: int64
rows
required
Array<object>
object
atStart
required
integer format: int64
base
required
integer format: int64
formKind
string
joined
required
integer format: int64
key
required
string
kind
required
string
name
required
string
others
integer format: int64
paid
required
integer format: int64
rate
number format: double
tooFew
required
boolean
total
required
object
atStart
required
integer format: int64
base
required
integer format: int64
formKind
string
joined
required
integer format: int64
key
required
string
kind
required
string
name
required
string
others
integer format: int64
paid
required
integer format: int64
rate
number format: double
tooFew
required
boolean
from
required
string format: date-time
hadHistory
required
boolean
helpers
required
Array<string>
movement
required
object
churned
required
object
cents
required
integer format: int64
count
required
integer format: int64
contraction
required
object
cents
required
integer format: int64
count
required
integer format: int64
expansion
required
object
cents
required
integer format: int64
count
required
integer format: int64
fromCents
required
integer format: int64
fromMembers
required
integer format: int64
new
required
object
cents
required
integer format: int64
count
required
integer format: int64
reactivated
required
object
cents
required
integer format: int64
count
required
integer format: int64
toCents
required
integer format: int64
toMembers
required
integer format: int64
needs
required
Array<object>
object
count
integer format: int64
due
string format: date-time
endsAt
string format: date-time
issue
integer format: int64
kind
required
string
Allowed values: past_due offer creative sponsor_payment member_email
limit
integer format: int64
list
string
name
string
overdue
boolean
sponsor
string
targetId
string
template
string
used
integer format: int64
period
required
string
Allowed values: 30d 90d 12m
readOnly
required
boolean
reference
string
shownFrom
string format: date-time
tiers
required
Array<object>
object
includes
required
Array<string>
members
required
integer format: int64
mrrCents
required
integer format: int64
offers
required
Array<object>
object
duration
required
string
members
required
integer format: int64
months
integer format: int64
name
required
string
paidCents
required
integer format: int64
period
required
string
priceCents
required
integer format: int64
tier
required
string
tierId
required
string
tiles
required
object
arrCents
required
integer format: int64
churnBase
required
integer format: int64
churnRate
number format: double
churned
required
integer format: int64
freeBase
required
integer format: int64
freeToPaid
required
integer format: int64
freeToPaidRate
number format: double
giftsCents
required
integer format: int64
members
required
integer format: int64
membersDelta
required
integer format: int64
mrrCents
required
integer format: int64
mrrDeltaCents
required
integer format: int64
mrrDeltaPct
number format: double
new
required
integer format: int64
sponsorsCents
required
integer format: int64
trialing
required
integer format: int64
to
required
string format: date-time
tooEarly
required
boolean
trials
required
object
becamePaid
required
integer format: int64
canceled
required
integer format: int64
ended
required
integer format: int64
endingFrom
object
count
required
integer format: int64
id
required
string
kind
required
string
Allowed values: campaign automation
name
required
string
endingSoon
required
integer format: int64
started
required
integer format: int64
trialing
required
integer format: int64
upgrades
required
object
rows
required
Array<object>
object
id
string
kind
required
string
Allowed values: campaign automation none
members
required
integer format: int64
mrrCents
required
integer format: int64
name
required
string
sentAt
string format: date-time
total
required
object
cents
required
integer format: int64
count
required
integer format: int64
window
required
integer format: int64

Example 

{
  "activity": [
    {
      "kind": "payment_failed"
    }
  ],
  "chart": {
    "marks": [
      {
        "kind": "moved"
      }
    ]
  },
  "conversions": {
    "byEmail": [
      {
        "kind": "campaign"
      }
    ],
    "latest": [
      {
        "matched": "click_token"
      }
    ]
  },
  "needs": [
    {
      "kind": "past_due"
    }
  ],
  "period": "30d",
  "trials": {
    "endingFrom": {
      "kind": "campaign"
    }
  },
  "upgrades": {
    "rows": [
      {
        "kind": "campaign"
      }
    ]
  }
}

default

Section titled “default”

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"
}
Report a problem with this pageReputeCast websiteHostReputeContent licensed under CC BY 4.0