How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rillet Contracts API

The Contracts API from Rillet — 5 operation(s) for contracts.

Rillet Contracts API is one of 29 APIs that Rillet publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contracts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 5 paths, and defines 71 schemas. It is described by OpenAPI 3.2.0, at version v4.0.

Requests are made against 2 base URLs: https://api.rillet.com, https://sandbox.api.rillet.com.

7 operations 5 paths 71 schemas 1 DELETE2 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v4.0
Base URL
https://api.rillet.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Rillet Contracts API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Contracts 7
POST
/contracts
Creates a contract
create-a-contract body → 200default
GET
/contracts
Lists all contracts
list-all-contracts 13 params → 200default
GET
/contracts/{contract_id}
Retrieves a contract
retrieve-a-contract 1 param → 200default
DELETE
/contracts/{contract_id}
Deletes a contract
delete-a-contract 1 param → 204default
POST
/contracts/{contract_id}/amendments
Amends a contract
amend-a-contract 1 param body → 200default
POST
/contracts/{contract_id}/amendments/preview
Previews contract amendment
preview-contract-amendment 1 param body → 200default
PUT
/contracts/{contract_id}/end
Ends an open-ended contract
end-an-open-ended-contract 1 param body → 204default

Schemas 71

The contract defines 71 schemas that model the data the API accepts and returns. The most detailed are ContractItem (15 properties), Contract (14 properties), ContractItemRequest (11 properties), CreateFullContractRequest (11 properties). Each schema is shown below with its type and property counts.

InvoiceScheduleInvoiceItem
object
7 properties 5 required
BillingScheme
RevenuePattern
string
DAILY means that the revenue is divided equally per day in the revenue period. EVENPERIOD means that the revenue is divided equally for each calendar month in…
AmendFullContractItemRequest
object
10 properties 5 required
UsageInvoiceCycle
string
When does the invoicing pricing cycle reset and results in an invoice. Calendar option is only allowed when usage invoice frequency is Monthly, and contract do…
RevenueRecognitionOnlyContractNewItemInAmendmentRequest
object
7 properties 4 required
ContractScope
string
The "FULL" scope includes revenue recognition and invoicing handled in Rillet. With the "REVENUERECOGNITIONONLY" scope, invoicing is handled outside Rillet.
ContractItem
object
15 properties 9 required
OneTimePrice
MonetaryAmount
object
2 properties 2 required
PerUnitBilling
object
3 properties 3 required
QuarterlyInvoicing
object
3 properties 3 required
UsageInvoicingFrequency
string
ExternalReference
object
For requests, only pre-defined custom IDs are accepted. In responses, an object imported through an integration (e.g. Stripe) would return the provider's objec…
3 properties 2 required
CalendarPeriod
object
2 properties 2 required
MonthlyProratedInvoicing
object
Monthly prorated invoicing is only available for contracts with usage products and a minimum usage commitment.
3 properties 3 required
RoundedMonetaryAmount
object
A monetary amount that must be rounded to the currency's default decimal places (e.g., 2 decimal places for USD).
2 properties 2 required
FixedPrice
object
1 property 1 required
FieldAssignments
array
SemiAnnualInvoicing
object
3 properties 3 required
ExpandedContract
CurrencyCode
string
Currency code following ISO-4217
CreateContractRequest
object
1 property 1 required
PageCursor
string
If defined, a cursor to retrieve the next page.
AmendRevenueRecognitionOnlyContractRequest
object
4 properties 4 required
AmendContractRequest
object
1 property 1 required
PaymentTerms
integer
AmendFullContractRequest
object
4 properties 4 required
ContractItemRequest
object
11 properties 4 required
InvoiceStatus
string
UsageInvoiceDate
string
When the usage invoice is created in relation to the usage cycle.
ExchangeRate
object
4 properties 4 required
Invoicing
RevenueRecognitionOnlyContractItemRequest
object
7 properties 4 required
RevenueRecognitionOnlyContractAmendingItemRequest
object
5 properties 2 required
TieredBilling
object
All tiers except for the highest have to define a value for upTo. There cannot be more than one tier with the same upTo value.
3 properties 3 required
UsageCommitment
object
2 properties 2 required
Error
object
4 properties 2 required
FixedRecurringPrice
PageLimit
integer
CreateRevenueRecognitionOnlyContractRequest
object
9 properties 7 required
AmountDiscount
object
2 properties 1 required
RevenueRecognitionOnlyContractTerminatedItemRequest
object
2 properties 1 required
Contract
object
14 properties 10 required
MinimumCommitmentInvoicingFrequency
string
MONTHLYPRORATED is only available for CALENDAR usage invoice cycle. It need to be the same as contract level invoicing frequency.
Pagination
object
1 property
CreateFullContractRequest
object
11 properties 6 required
ContractStatus
string
UsageConfiguration
object
4 properties 1 required
PreviewContractAmendmentRequest
object
3 properties 3 required
InvoiceSchedule
object
1 property
AmendmentEffectiveFrom
string
Defines when the amendment takes effect. - ASOFAMENDMENTDATE: apply changes as of the amendment date - ENDOFCURRENTBILLINGCYCLE: apply at the end of the curren…
TaxRateWithOptionalAmount
object
5 properties 4 required
UsageInvoicing
object
4 properties 4 required
PercentageDiscount
object
2 properties 1 required
InvoiceItem
object
11 properties 10 required
InvoiceScheduleInvoice
object
6 properties 4 required
YearlyInvoicing
object
3 properties 3 required
Tier
object
At least one of flatPrice or perUnitPrice has to be defined. flatPrice is the price for the entire tier. perUnitPrice is price for units relevant to the tier.
3 properties 1 required
UsagePrice
Price
MonthlyInvoicing
object
3 properties 3 required
TaxRate
1 required
Discount
EndOpenEndedContractRequest
object
1 property 1 required
AccountCode
string
The account code found in the Chart of Accounts
MinimumCommitmentInvoicing
object
2 properties 2 required
RecurringPrice
object
1 property 1 required
ContractInvoice
object
9 properties 9 required
ItemRevenue
object
3 properties
CountryCode
string
Two-letter country code (ISO 3166-1 alpha-2).

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rillet-contracts-api-openapi.yml Raw ↑

Other APIs Rillet publishes across the network.

Rillet API Key API
Rillet Bank accounts API
Rillet Bank Transactions API
Rillet Bill Payments API
Rillet Bills API
Rillet Books periods API
Rillet Charges API
Rillet Chart of Accounts API
Rillet Contract Items API
Rillet Credit Memos API
Rillet Customer Payments API
Rillet Customers API
Where this information came from

This is an independent, third-party profile of Rillet Contracts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.