Skip to content
ReputeCastReputeCast Docs

Settings › Payments: the connections, their webhook, checkout and tax

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

Permission: earn:view

Keys and webhook signing secrets are write-only: only a hint of the key is returned.

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

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
active
required
string
Allowed values: live test ""
activeSubscriptions
required
integer format: int64
canEditPrices
required
boolean
canManage
required
boolean
checkout
required
object
currency
required
string
currencyFixed
required
boolean
portal
required
object
billingEmail
required
boolean
cancel
required
boolean
invoices
required
boolean
switchPeriod
required
boolean
updateCard
required
boolean
pricesIncludeTax
required
boolean
taxAtCheckout
required
boolean
taxAvailable
required
boolean
helpers
required
Array<string>
live
object
account
required
object
country
required
string
currency
required
string
id
required
string
name
required
string
taxEnabled
required
boolean
checkedAt
string format: date-time
connectedAt
string format: date-time
connectedBy
string
createKeyUrl
required
string
dashboardUrl
required
string
demo
required
boolean
emailsUrl
required
string
granted
required
integer format: int64
health
required
string
Allowed values: setup key_rejected webhook_missing missing_permissions webhook_silent connected
id
required
string
keyHint
required
string
keyRejectedAt
string format: date-time
keysUrl
required
string
mode
required
string
Allowed values: live test
permissions
required
Array<object>
object
access
required
string
Allowed values: read write
ok
boolean
resource
required
string
portalSet
required
boolean
provider
required
string
Allowed values: stripe
providerName
required
string
status
required
string
Allowed values: setup connected
step
required
string
Allowed values: check webhook settings done
webhook
required
object
byType
required
Array<object>
object
count
required
integer format: int64
type
required
string
events
required
Array<string>
events24h
required
integer format: int64
firstEventAt
string format: date-time
firstEventType
string
gapCheckedAt
string format: date-time
gapRuns
required
Array<object>
object
applied
required
integer format: int64
at
required
string format: date-time
types
required
object
key
additional properties
integer format: int64
id
string
lastEventAt
string format: date-time
lastEventType
string
manual
required
boolean
missingAt
string format: date-time
nextGapAt
string format: date-time
reach
required
object
at
string format: date-time
checked
required
boolean
code
string
host
required
string
ok
required
boolean
reason
string
registered
required
boolean
registeredAt
string format: date-time
rejected24h
required
integer format: int64
secretStored
required
boolean
silentHours
integer format: int64
status
required
string
Allowed values: unregistered waiting receiving silent missing
url
required
string
webhooksUrl
required
string
permissions
required
Array<object>
object
access
required
string
Allowed values: read write
ok
boolean
resource
required
string
providers
required
Array<object>
object
available
required
boolean
capabilities
required
Array<string>
key
required
string
Allowed values: stripe paddle lemonsqueezy
merchantOfRecord
required
boolean
name
required
string
test
object
account
required
object
country
required
string
currency
required
string
id
required
string
name
required
string
taxEnabled
required
boolean
checkedAt
string format: date-time
connectedAt
string format: date-time
connectedBy
string
createKeyUrl
required
string
dashboardUrl
required
string
demo
required
boolean
emailsUrl
required
string
granted
required
integer format: int64
health
required
string
Allowed values: setup key_rejected webhook_missing missing_permissions webhook_silent connected
id
required
string
keyHint
required
string
keyRejectedAt
string format: date-time
keysUrl
required
string
mode
required
string
Allowed values: live test
permissions
required
Array<object>
object
access
required
string
Allowed values: read write
ok
boolean
resource
required
string
portalSet
required
boolean
provider
required
string
Allowed values: stripe
providerName
required
string
status
required
string
Allowed values: setup connected
step
required
string
Allowed values: check webhook settings done
webhook
required
object
byType
required
Array<object>
object
count
required
integer format: int64
type
required
string
events
required
Array<string>
events24h
required
integer format: int64
firstEventAt
string format: date-time
firstEventType
string
gapCheckedAt
string format: date-time
gapRuns
required
Array<object>
object
applied
required
integer format: int64
at
required
string format: date-time
types
required
object
key
additional properties
integer format: int64
id
string
lastEventAt
string format: date-time
lastEventType
string
manual
required
boolean
missingAt
string format: date-time
nextGapAt
string format: date-time
reach
required
object
at
string format: date-time
checked
required
boolean
code
string
host
required
string
ok
required
boolean
reason
string
registered
required
boolean
registeredAt
string format: date-time
rejected24h
required
integer format: int64
secretStored
required
boolean
silentHours
integer format: int64
status
required
string
Allowed values: unregistered waiting receiving silent missing
url
required
string
webhooksUrl
required
string
testMembers
required
integer format: int64
unmapped
required
Array<object>
object
amountCents
required
integer format: int64
currency
required
string
foundAt
required
string format: date-time
id
required
string
members
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
mode
required
string
Allowed values: live test
period
required
string
Allowed values: month year ""
priceId
required
string
subscriptions
required
integer format: int64
webhookEvents
required
Array<string>

Example 

{
  "active": "live",
  "live": {
    "health": "setup",
    "mode": "live",
    "permissions": [
      {
        "access": "read"
      }
    ],
    "provider": "stripe",
    "status": "setup",
    "step": "check",
    "webhook": {
      "status": "unregistered"
    }
  },
  "permissions": [
    {
      "access": "read"
    }
  ],
  "providers": [
    {
      "key": "stripe"
    }
  ],
  "test": {
    "health": "setup",
    "mode": "live",
    "permissions": [
      {
        "access": "read"
      }
    ],
    "provider": "stripe",
    "status": "setup",
    "step": "check",
    "webhook": {
      "status": "unregistered"
    }
  },
  "unmapped": [
    {
      "members": [
        {
          "kind": "stripe",
          "next": "renews",
          "period": "month",
          "source": {
            "kind": "campaign"
          },
          "status": "trialing"
        }
      ],
      "mode": "live",
      "period": "month"
    }
  ]
}

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