Plans & offers: the tiers with their prices, members and MRR, and the upgrade page

GET

/api/v1/workspaces/{workspace}/earn/plans

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/earn/plans"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/earn/plans';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/earn/plans \
  --header 'Authorization: Bearer <token>'

Permission: earn:view

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

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

Workspace slug

Responses

200

application/json

object

brand

required

object

accent

required

string

ground

required

string

onAccent

required

string

publisher

required

string

soft

required

string

text

required

string

canEdit

required

boolean

connected

required

boolean

currency

required

string

free

required

object

line

required

string

list

object

required

string

name

required

string

readers

required

integer format: int64

text

required

string

helpers

required

Array<string>

lists

required

Array<object>

object

required

string

name

required

string

tiers

required

Array<object>

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

required

string

importedAt

string format: date-time

importedFrom

string

includes

required

Array<string>

lists

required

Array<object>

object

required

string

name

required

string

monthly

object

amountCents

required

integer format: int64

currency

required

string

discounted

required

integer format: int64

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

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

string format: date-time

error

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

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

upgradePage

required

object

checkoutsStarted

required

integer format: int64

completed

required

integer format: int64

host

required

string

live

required

boolean

paidAtOnce

required

integer format: int64

testCheckoutUrl

string

testMode

required

boolean

trials

required

integer format: int64

url

required

string

visits

required

integer format: int64

Example

{
  "tiers": [
    {
      "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

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