Resume recurring charge rule

POST

/api/recurring-charges/{id}/resume

curl --request POST \
  --url https://api.getvespy.com/api/recurring-charges/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/resume \
  --header 'Authorization: Bearer <token>'

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Default Response

Media typeapplication/json

object

recurringChargeRule

required

object

amountCents

required

integer

>= 1

categoryId

required

string format: uuid

createdAt

required

string format: date-time

dayOfMonth

required

integer

>= 1 <= 31

endDate

required

string format: date

nullable

frequency

required

string

Allowed values: monthly

id

required

string format: uuid

kind

required

string

Allowed values: rent fee

label

required

string

>= 1 characters <= 160 characters

leaseId

required

string format: uuid

nullable

organizationId

required

string format: uuid

propertyId

required

string format: uuid

nullable

startDate

required

string format: date

status

required

string

Allowed values: draft active paused ended

tenantId

required

string format: uuid

nullable

unitId

required

string format: uuid

nullable

updatedAt

required

string format: date-time

Example

{
  "recurringChargeRule": {
    "frequency": "monthly",
    "kind": "rent",
    "status": "draft"
  }
}

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