Get the autopay schedule for the authenticated tenant

GET

/api/portal/autopay

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

• Production
• Development
• Local

Authorizations

• bearerAuth

Responses

200

Default Response

Media typeapplication/json

object

autopay

required

object

amountStrategy

required

string

Allowed values: balance_due fixed

createdAt

required

string format: date-time

dayOfMonth

required

integer

>= 1 <= 28

fixedAmountCents

required

integer

nullable >= 1

frequency

required

string

Allowed values: monthly

id

required

string format: uuid

leaseId

required

string format: uuid

nextRunAt

required

string format: date-time

paymentMethodId

required

string format: uuid

status

required

string

Allowed values: active paused canceled

tenantId

required

string format: uuid

updatedAt

required

string format: date-time

Example

{
  "autopay": {
    "amountStrategy": "balance_due",
    "frequency": "monthly",
    "status": "active"
  }
}

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