Get the organization platform billing status

GET

/api/staff/billing/status

curl --request GET \
  --url https://api.getvespy.com/api/staff/billing/status \
  --header 'Authorization: Bearer <token>'

• Production
• Development
• Local

Authorizations

• bearerAuth

Responses

200

Default Response

Media typeapplication/json

object

billing

required

object

accessMode

required

string

Allowed values: grandfathered subscription_required active grace_period read_only

canMutatePortfolio

required

boolean

currentPeriodEnd

required

string format: date-time

nullable

graceEndsAt

required

string format: date-time

nullable

stripeSubscriptionStatus

required

string

nullable

subscribed

required

boolean

Example

{
  "billing": {
    "accessMode": "grandfathered"
  }
}

401

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

503

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}