Enroll the authenticated tenant in autopay

POST

/api/portal/autopay

curl --request POST \
  --url https://api.getvespy.com/api/portal/autopay \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "authorizationLanguageVersion": "example", "leaseId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "paymentMethodId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

• Production
• Development
• Local

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

authorizationLanguageVersion

required

string

>= 1 characters <= 80 characters

leaseId

required

string format: uuid

paymentMethodId

required

string format: uuid

Example^generated

{
  "authorizationLanguageVersion": "example",
  "leaseId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "paymentMethodId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

201

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

400

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

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

404

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

409

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