Cancel a Contract

Path Parameters

string

required

The contract id.

Response

200 - application/json

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.

contract.id

string

required

Unique identifier for the contract.

contract.startDate

string

required

Date when the contract becomes active.

contract.endDate

string | null

required

Optional date when the contract expires. If null, the contract has no end date.

contract.billingEndDay

number

required

Day of the month when the billing cycle ends (1-31).

Required range: 1 < x < 31

contract.status

enum<string>

required

Current status of the contract.

Available options:

active,

canceled,

completed

contract.plans

object[]

required

List of subscription plans associated with this contract.

contract.plans.id

string

required

contract.plans.name

string

required

Minimum length: 1

contract.plans.description

string | null

required

contract.paymentSettings

object | null

required

Schema defining payment gateway settings for a contract. Required if payment gateway is enabled.

contract.paymentSettings.scheduledPaymentDay

number

required

The specific day of the month when the payment will be scheduled. For example, a value of 1 means the payment will be scheduled on the 1st day of the month. A value of 31 represents the last day of the month, regardless of whether the month has 28, 30, or 31 days.

Required range: 1 < x < 31

contract.paymentSettings.dueOffsetDays

number

required

Number of days after the payment start date until payment is due (minimum of 5 days).

Required range: x > 5

customer

object

required

Schema representing a customer.

customer.id

string

required

The unique identifier of the customer.

customer.externalId

string

required

External identifier for the customer.

Minimum length: 1

customer.name

string

required

The name of the customer.

Minimum length: 1

paymentAccount

object

required

Schema representing a payment account.

paymentAccount.id

string

required

The unique identifier of the payment account.

paymentAccount.businessName

string

required

The legal business name of the payment account holder.

Minimum length: 1

paymentAccount.tradeName

string | null

required

The trade or "doing business as" name of the payment account holder.

Minimum length: 1

paymentAccount.taxId

string

required

The tax identification number (CNPJ) of the payment account holder.

paymentAccount.email

string | null

required

The contact email address for the payment account.

paymentAccount.address

object | null

required

The physical address associated with the payment account.

paymentAccount.address.zipCode

string

required

The postal code (CEP) of the address.

Required string length: 8

paymentAccount.address.number

string

required

The street number of the address.

Minimum length: 1

paymentAccount.address.street

string

required

The street name of the address.

Minimum length: 1

paymentAccount.address.neighborhood

string

required

The neighborhood or district of the address.

Minimum length: 1

paymentAccount.address.city

string

required

The city name of the address.

Minimum length: 1

paymentAccount.address.state

enum<string>

required

The state abbreviation of the address.

Available options:

AC,

AL,

AP,

AM,

BA,

CE,

DF,

ES,

GO,

MA,

MT,

MS,

MG,

PA,

PB,

PR,

PE,

PI,

RJ,

RN,

RS,

RO,

RR,

SC,

SP,

SE,

TO

paymentAccount.address.country

enum<string>

required

The country code of the address.

Available options:

Brasil

paymentAccount.address.complement

string | null

required

Additional address information like apartment number, floor, etc.

Aira Docs

Events

Invoices

Contracts

Resources

Cancel a Contract

Path Parameters

Response