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

RentCheck Subscriptions API

The Subscriptions API from RentCheck — 6 operation(s) for subscriptions.

RentCheck Subscriptions API is one of 31 APIs that RentCheck publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 6 operations across 6 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://prod-public-api.getrentcheck.com.

6 operations 6 paths 5 schemas 3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://prod-public-api.getrentcheck.com
Authentication
HTTP Bearer, API Key, API Key
Resource Areas
1

Authentication & Security 3

RentCheck Subscriptions API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as x-app-id (x-app-id). An API key is passed in the header as x-app-secret (x-app-secret). By default, every request must be authenticated.

  • bearerAuth — Authorization key needed to use the API
  • x-app-id — Represents the identification of you application
  • x-app-secret — Represents the secret for your application

Paths & Operations 6

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

Subscriptions 6
POST
/v1/subscriptions/trial
Create a free trial subscription
1 param body → 200400401404
GET
/v1/subscriptions/me
Get subscription
→ 200401404
GET
/v1/subscriptions/invoices/{invoiceId}/get-download-url
Get a download URL for an invoice
1 param → 200401404
GET
/v1/subscriptions/invoices
Get invoices for the caller's subscription
→ 200401404
POST
/v1/subscriptions/me/requests
Request a new plan / trial for the caller's subscription
body → 200400401404
PUT
/v1/subscriptions
Update the caller's subscription
body → 200400401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are subscription_get_by_user_response_model (14 properties), subscription_invoice_response_model (4 properties), subscription_create_trial_request_model (3 properties), subscription_update_request_model (2 properties). Each schema is shown below with its type and property counts.

subscription_create_request_request_model
object
Used to request a trial extension or plan change.
2 properties 1 required
subscription_get_by_user_response_model
object
14 properties 8 required
subscription_update_request_model
object
At least one of plan or addons should be supplied.
2 properties
subscription_create_trial_request_model
object
Request body for creating a subscription trial.
3 properties 3 required
subscription_invoice_response_model
object
Subset of the Chargebee invoice payload surfaced to clients.
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rentcheck-subscriptions-api-openapi.yml Raw ↑

Other APIs RentCheck publishes across the network.

RentCheck Account Settings API
RentCheck Automations API
RentCheck Buildings API
RentCheck Chargebee API
RentCheck Communities API
RentCheck Dashboard API
RentCheck File Requests API
RentCheck Filter Segments API
RentCheck Inspection Features API
RentCheck Inspections API
RentCheck Inspections Templates API
RentCheck Inspections V2 API