A tier with its prices and their sync with the provider

GET

/api/v1/workspaces/{workspace}/earn/tiers/{id}

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

• Your ReputeCast public URL

Permission: earn:view

Authorizations

• bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

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

Workspace slug

id

required

Id

string format: uuid

Id

Responses

200

OK

Media typeapplication/json

object

accessRank

required

integer format: int64

archivedAt

string format: date-time

benefits

required

Array<string>

canDelete

required

boolean

createdAt

required

string format: date-time

description

required

string

discountedYearly

required

integer format: int64

hiddenLink

required

string

highlight

string

id

required

string

importedAt

string format: date-time

importedFrom

string

includes

required

Array<string>

lists

required

Array<object>

object

id

required

string

name

required

string

monthly

object

amountCents

required

integer format: int64

currency

required

string

discounted

required

integer format: int64

id

required

string

members

required

integer format: int64

offers

required

Array<object>

object

count

required

integer format: int64

label

required

string

origin

required

string

Allowed values: tier mapped

paying

required

integer format: int64

period

required

string

Allowed values: month year

status

required

string

Allowed values: current legacy

stripeId

string

stripeLiveId

string

stripeTestId

string

stripeUrl

string

mrrCents

required

integer format: int64

name

required

string

origin

string

paying

required

integer format: int64

payingMonthly

required

integer format: int64

payingYearly

required

integer format: int64

prices

required

Array<object>

object

amountCents

required

integer format: int64

currency

required

string

discounted

required

integer format: int64

id

required

string

members

required

integer format: int64

offers

required

Array<object>

object

count

required

integer format: int64

label

required

string

origin

required

string

Allowed values: tier mapped

paying

required

integer format: int64

period

required

string

Allowed values: month year

status

required

string

Allowed values: current legacy

stripeId

string

stripeLiveId

string

stripeTestId

string

stripeUrl

string

productId

string

productUrl

string

shortName

required

string

slug

required

string

syncStatus

required

string

Allowed values: draft synced failed

syncSteps

required

Array<object>

object

amountCents

integer format: int64

at

string format: date-time

error

string

id

string

status

required

string

Allowed values: done failed pending

step

required

string

Allowed values: product month year

tries

integer format: int64

syncedAt

string format: date-time

trialDays

required

integer format: int64

Allowed values: 0 7 14 30

trialing

required

integer format: int64

visibility

required

string

Allowed values: public hidden archived

yearly

object

amountCents

required

integer format: int64

currency

required

string

discounted

required

integer format: int64

id

required

string

members

required

integer format: int64

offers

required

Array<object>

object

count

required

integer format: int64

label

required

string

origin

required

string

Allowed values: tier mapped

paying

required

integer format: int64

period

required

string

Allowed values: month year

status

required

string

Allowed values: current legacy

stripeId

string

stripeLiveId

string

stripeTestId

string

stripeUrl

string

Example

{
  "monthly": {
    "origin": "tier",
    "period": "month",
    "status": "current"
  },
  "prices": [
    {
      "origin": "tier",
      "period": "month",
      "status": "current"
    }
  ],
  "syncStatus": "draft",
  "syncSteps": [
    {
      "status": "done",
      "step": "product"
    }
  ],
  "trialDays": 0,
  "visibility": "public",
  "yearly": {
    "origin": "tier",
    "period": "month",
    "status": "current"
  }
}

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"
}