Skip to content
ReputeCastReputeCast Docs

A contact's paid access, for the contact profile

GET
/api/v1/workspaces/{workspace}/earn/contacts/{contactId}
curl --request GET \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/earn/contacts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Permission: earn:view

Null when the contact has no paid access and never had.

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

contactId
required

Contact id

string format: uuid

Contact id

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
accessPaused
required
boolean
amountCents
required
integer format: int64
billingDiffers
required
boolean
billingEmail
string
canManage
required
boolean
cancelAt
string format: date-time
cancelReason
string
canceledAt
string format: date-time
canceledBy
string
clickedAt
string format: date-time
contactId
required
string
currency
required
string
customerId
string
customerUrl
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
emails
required
Array<string>
endReason
string
failedAt
string format: date-time
failureReason
string
failureText
string
giftFrom
string
giftMonths
integer format: int64
grantNote
string
grantUntil
string format: date-time
helpers
required
Array<string>
hidden
required
boolean
id
required
string
importedAt
string format: date-time
kind
required
string
Allowed values: stripe complimentary gift
legacy
required
boolean
link
required
string
lists
required
Array<string>
ltvCents
required
integer format: int64
matchedBy
string
name
required
string
next
required
string
Allowed values: renews ends retries trial_ends no_end ended
nextAt
string format: date-time
paidCents
required
integer format: int64
period
required
string
Allowed values: month year ""
periodShown
required
boolean
refundedCents
required
integer format: int64
renewalReminder
string format: date-time
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
subscriptionId
string
subscriptionUrl
string
taxAdded
required
boolean
test
required
boolean
tier
required
string
tierId
string
tierName
required
string
timeline
required
Array<object>
object
actor
string
amountCents
integer format: int64
at
required
string format: date-time
currency
string
data
required
object
key
additional properties
id
required
string
kind
required
string
messageId
string
messageStatus
string
provider
string
stripeEvent
string
test
required
boolean
warning
object
subscriptions
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

Example 

{
  "kind": "stripe",
  "next": "renews",
  "period": "month",
  "source": {
    "kind": "campaign"
  },
  "status": "trialing",
  "warning": {
    "subscriptions": [
      {
        "kind": "stripe",
        "next": "renews",
        "period": "month",
        "source": {
          "kind": "campaign"
        },
        "status": "trialing"
      }
    ]
  }
}

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