Get Contract
This endpoint allows the retrieval of a contract.
{
"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
}
},
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "<string>",
"name": "<string>"
},
"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
API Key Authentication.
Path Parameters
Response
The request was successfully processed and the contract information is returned.
Schema defining the contract details.
Unique identifier for the contract.
Date when the contract becomes active.
Optional date when the contract expires. If null, the contract has no end date.
Day of the month when the billing cycle ends (1-31).
1 <= x <= 31Current status of the contract.
active, canceled, completed Schema defining payment gateway settings for a contract. Required if payment gateway is enabled.
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.
1 <= x <= 31Number of days after the payment start date until payment is due (minimum of 5 days).
x >= 5Schema representing a payment account.
The unique identifier of the payment account.
The legal business name of the payment account holder.
1The trade or "doing business as" name of the payment account holder.
1The tax identification number (CNPJ) of the payment account holder.
The contact email address for the payment account.
The physical address associated with the payment account.
The postal code (CEP) of the address.
8The street number of the address.
1The street name of the address.
1The neighborhood or district of the address.
1The city name of the address.
1The state abbreviation of the address.
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 The country code of the address.
Brasil Additional address information like apartment number, floor, etc.
{
"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
}
},
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "<string>",
"name": "<string>"
},
"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>"
}
}
}