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 Customers API

The Customers API from Rillet — 2 operation(s) for customers.

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

Tagged areas include Customers. 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 11 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 11 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 Customers 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.

Customers 5
GET
/customers
Lists all customers
list-all-customers 7 params → 200default
POST
/customers
Creates a customer
create-a-customer body → 200default
GET
/customers/{customer_id}
Retrieves a customer
retrieve-a-customer 1 param → 200default
PUT
/customers/{customer_id}
Updates a customer
update-a-customer 1 param body → 200default
DELETE
/customers/{customer_id}
Deletes a customer
delete-a-customer 1 param → 204default

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are CustomerRequest (10 properties), Address (6 properties), Error (4 properties), ExternalReference (3 properties). Each schema is shown below with its type and property counts.

Customer
3 required
Error
object
4 properties 2 required
FieldAssignments
array
PageCursor
string
If defined, a cursor to retrieve the next page.
PageLimit
integer
CustomerRequest
object
10 properties 1 required
Pagination
object
1 property
CustomerEmail
object
2 properties 2 required
CountryCode
string
Two-letter country code (ISO 3166-1 alpha-2).
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
Address
object
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rillet-customers-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