Lease charges

Delete a recurring credit

Stops a recurring credit. Set deleteAllCredits to true to also remove the credits it has already issued.

DELETE

https://api.portal.magicdoor.com/company-app/leases/{leaseId}/charges/recurring-credits/{recurringCreditId}

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

leaseIdstringrequired

The lease the recurring credit is on. A Snowflake id, sent as a decimal string.

example: 1830472847398404096

recurringCreditIdstringrequired

The recurring credit to delete. A Snowflake id, sent as a decimal string.

example: 1861019384756201984

Body

application/json

deleteAllCreditsbooleanrequired

Whether to also remove the credits this has already issued.

Response

200 · The recurring credit was deleted. No body is returned.

400 · The request failed validation. `errors` maps each field name to what was wrong with it.

401 · The access token is missing, expired, or not for this company.

404 · No recurring credit matched the id, or it belongs to another company.

Request

curl --request DELETE \
  --url 'https://api.portal.magicdoor.com/company-app/leases/1830472847398404096/charges/recurring-credits/1861019384756201984' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "deleteAllCredits": false
}'

Body

{
  "deleteAllCredits": false
}