Terminate a contract
Use this endpoint to terminate a contract. Provide a terminationDate in the request body to schedule the termination for a specific date, or omit it to terminate the contract immediately. The contract's status is set to PendingTermination and its end date is updated accordingly.
Authorization
BearerAuthorizer In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
The date on which the contract should be terminated. If omitted, the contract is terminated immediately.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/contracts/string/terminate" \ -H "Content-Type: application/json" \ -d '{}'{ "contractId": "string"}{ "type": "invalid_request_error", "code": "string", "message": "string", "param": "string", "params": [ { "param": "string", "message": "string" } ]}{ "type": "authentication_error", "code": "authentication_failed", "message": "string"}{ "type": "rate_limit_error", "code": "rate_limit_exceeded", "message": "string"}{ "type": "api_error", "code": "internal_error", "message": "string"}Get contract by integration id GET
Use this endpoint to get a specific contract using its integration provider and identifier.
Refresh the credit grants on a contract POST
Use this endpoint to refresh the credit grants on a contract by creating a new contract phase (a contract revision) that takes effect immediately. Provide a list of credit grants to refresh in the request body — each is identified by its credit product (credit type) id and is set to non-prorated in the new phase, optionally with a new price. Every other credit grant on the contract is set to prorated. If the grants list is omitted, all credit grants on the contract are refreshed (set to non-prorated). If a supplied credit product matches more than one grant product on the contract and a newPrice is provided, the request is rejected because the price cannot be applied unambiguously.