Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rillet Draft Contracts API

The Draft Contracts API from Rillet — 2 operation(s) for draft contracts.

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

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

This API exposes 5 operations across 2 paths, and defines 26 schemas. It is described by OpenAPI 3.1.0, at version v4.0.

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

5 operations 2 paths 26 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

Paths & Operations 5

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

Draft Contracts 5
GET
/draft-contracts/{draft_contract_id}
Retrieves a draft contract
retrieve-a-draft-contract 1 param → 200default
PUT
/draft-contracts/{draft_contract_id}
Updates a draft contract
update-a-draft-contract 1 param body → 200default
DELETE
/draft-contracts/{draft_contract_id}
Deletes a draft contract
delete-a-draft-contract 1 param → 204default
GET
/draft-contracts
Lists all draft contracts
list-all-draft-contracts 4 params → 200default
POST
/draft-contracts
Creates a draft contract
create-a-draft-contract body → 200default

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are DraftContract (11 properties), CreateDraftContractRequest (10 properties), DraftContractItem (7 properties), DraftContractItemRequest (6 properties). Each schema is shown below with its type and property counts.

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
CreateDraftContractRequest
object
10 properties 7 required
BillingScheme
DraftContractItem
object
7 properties 4 required
Price
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
Discount
Pagination
object
1 property
DraftContract
object
11 properties 8 required
FixedRecurringPrice
UsagePrice
DraftContractItemRequest
object
6 properties 3 required
MonetaryAmount
object
2 properties 2 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
Error
object
4 properties 2 required
PageCursor
string
If defined, a cursor to retrieve the next page.
PageLimit
integer
FixedPrice
object
1 property 1 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
CurrencyCode
string
Currency code following ISO-4217
AmountDiscount
object
2 properties 1 required
OneTimePrice
ContractScope
string
The "FULL" scope includes revenue recognition and invoicing handled in Rillet. With the "REVENUERECOGNITIONONLY" scope, invoicing is handled outside Rillet.
PerUnitBilling
object
3 properties 3 required
PercentageDiscount
object
2 properties 1 required
RecurringPrice
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rillet-draft-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 Contracts API
Rillet Credit Memos API
Rillet Customer Payments API