Get customer's contracts by

Required Scopes(any of): CUSTOMER_CONTRACT_READ, CUSTOMER_READ

Returns customer's contracts by one of the given parameters

SecurityApiKeyAuth

Request

query Parameters

cardNumber

string

Card number to identify the customer

cardNumberFormat

string (CardNumberFormat)

Default: "DECIMAL"

Defines how card numbers are interpreted

Enum: "DECIMAL" "HEX_MSB" "HEX_LSB"

debtorId

string

Unique ID of the debtor

qrCodeUuid

string <uuid>

Deprecated

QR code UUID to identify the customer

barcode

string

Barcode to identify the customer

customerNumber

string

Customer number to identify the customer

status

string (ContractStatus)

The contracts desired or current status

Enum:	Description
ACTIVE	Identifies active contracts
INACTIVE	Identifies inactive contracts

Example: status=ACTIVE

Responses

200

400

Validation of the request failed.

401

Authentication failed. No api-key, wrong api-key or wrong header name.

403

Authorization failed. The caller has no privilege to the given resource.

404

Entity does not exists.

409

Conflict

429

Access denied - rate limit is exceeded.

500

Unexpected system error.

get/v1/customers/contracts/by

Request samples

curl

Response samples

application/json

[{"id": 1000,
"createdDate": "2022-01-01",
"startDate": "2022-01-01",
"endDate": "2022-10-01",
"rateName": "Premium",
"contractStatus": "ACTIVE",
"cancellationPeriod": {"periodValue": 10,
"periodUnit": "DAY"
},
"cancelled": true,
"cancellationDate": "2022-10-10",
"cancellationReceiptDate": "2022-10-10",
"cancellationReason": "Officially ordered studio closure",
"price": 19.9,
"priceDetails": {"basePrice": {"amount": 20,
"currency": "EUR"
},
"currentPrice": {"amount": 20,
"currency": "EUR"
},
"paymentFrequency": {"id": 203,
"type": "FREE",
"term": {"value": 2,
"unit": "WEEK"
},
"price": {"amount": 20,
"currency": "EUR"
},
"monthDaysToPrices": [{"monthDay": {"month": "JANUARY",
"monthValue": 0,
"dayOfMonth": 0
},
"price": {"amount": 20,
"currency": "EUR"
}
}
],
"termsToPrices": [{"term": {"value": 2,
"unit": "WEEK"
},
"price": {"amount": 20,
"currency": "EUR"
}
}
]
}
},
"lastPossibleCancellationDate": "2019-08-24",
"term": {"periodValue": 10,
"periodUnit": "DAY"
},
"extensionTerm": {"periodValue": 10,
"periodUnit": "DAY"
},
"flatFeeContracts": [{"id": 0,
"rateName": "Regular",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"paymentFrequency": "NON_RECURRING",
"price": 19.9,
"priceDetails": {"basePrice": {"amount": 20,
"currency": "EUR"
},
"currentPrice": {"amount": 20,
"currency": "EUR"
},
"paymentFrequency": {"id": 203,
"type": "FREE",
"term": {"value": 2,
"unit": "WEEK"
},
"price": {"amount": 20,
"currency": "EUR"
},
"monthDaysToPrices": [{"monthDay": { },
"price": null
}
],
"termsToPrices": [{"term": null,
"price": null
}
]
}
},
"cancelled": true,
"cancellationDate": "2022-10-10",
"cancellationReceiptDate": "2022-10-10",
"contractStatus": "ACTIVE"
}
],
"moduleContracts": [{"id": 0,
"rateName": "Regular",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"paymentFrequency": "NON_RECURRING",
"price": 19.9,
"priceDetails": {"basePrice": {"amount": 20,
"currency": "EUR"
},
"currentPrice": {"amount": 20,
"currency": "EUR"
},
"paymentFrequency": {"id": 203,
"type": "FREE",
"term": {"value": 2,
"unit": "WEEK"
},
"price": {"amount": 20,
"currency": "EUR"
},
"monthDaysToPrices": [{"monthDay": { },
"price": null
}
],
"termsToPrices": [{"term": null,
"price": null
}
]
}
},
"cancelled": true,
"cancellationDate": "2022-10-10",
"cancellationReceiptDate": "2022-10-10",
"contractStatus": "ACTIVE"
}
],
"signedDocumentUrl": "string"
}
]