POST
/
v1
/
contracts
/
{id}
/
cancel
Cancel contract
curl --request POST \
  --url https://api.useaira.com/v1/contracts/{id}/cancel \
  --header 'X-API-KEY: <api-key>'
{
  "contract": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "startDate": "2023-12-25",
    "endDate": "2023-12-25",
    "billingEndDay": 16,
    "status": "active",
    "plans": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "description": "<string>"
      }
    ],
    "paymentSettings": {
      "scheduledPaymentDay": 16,
      "dueOffsetDays": 6
    },
    "billingSettings": {
      "billingCycleMinimumAmount": 1
    },
    "customFields": {}
  },
  "customer": {
    "id": "<string>",
    "externalId": "cust_1234567890abcdef",
    "name": "Acme Inc.",
    "customFields": {
      "custom_field_1": "value1",
      "custom_field_2": "value2"
    }
  },
  "paymentAccount": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "businessName": "<string>",
    "tradeName": "<string>",
    "taxId": "<string>",
    "email": "jsmith@example.com",
    "address": {
      "zipCode": "<string>",
      "number": "<string>",
      "street": "<string>",
      "neighborhood": "<string>",
      "city": "<string>",
      "state": "AC",
      "country": "Brasil",
      "complement": "<string>"
    }
  }
}

Authorizations

X-API-KEY
string
header
required

API Key Authentication.

Path Parameters

id
string<uuid>
required

The contract id.

Response

The request was successfully processed, and the contract has been canceled. The response contains the details of the canceled contract.

contract
object
required

Schema defining the contract details.

customer
object
required

Schema representing a customer.

paymentAccount
object
required

Schema representing a payment account.