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

Rye Commissions API

The Commissions API from Rye — 2 operation(s) for commissions.

Rye Commissions API is one of 13 APIs that Rye publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Commissions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 2 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 1.0.5.

Requests are made against a single base URL, https://staging.api.rye.com.

2 operations 2 paths 10 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.5
Base URL
https://api.rye.com/api/v1/
Authentication
API Key
Contact
License
UNLICENSED
Terms of Service
Resource Areas
1

Authentication & Security 1

Rye Commissions API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (bearerAuth).

  • bearerAuth — Rye API key

Paths & Operations 2

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

Commissions 2
GET
/api/v1/commissions/{id}
Retrieve commission
GetCommission 1 param → 200401404
GET
/api/v1/commissions
List commissions
ListCommissions 6 params → 200401422

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are CommissionResponse (10 properties), ValidateError (5 properties), NotFoundError (3 properties), AuthenticationError (3 properties). Each schema is shown below with its type and property counts.

FieldErrors
object
NotFoundError
object
3 properties 2 required
CommissionResponse
object
A commission earned (or owed) on a completed checkout intent.
10 properties 9 required
ValidateError
object
5 properties 4 required
CommissionListResponse
object
Paginated commissions response. Use pageInfo.endCursor as the next page's after query parameter to walk forward; use pageInfo.startCursor as the next page's be…
2 properties 2 required
CommissionType
string
Type of commission earned on an order. Canonical definition used by both the API contract and the internal @rye-com/ci-commissions package.
CommissionStatus
string
Lifecycle status of a commission record.
Money
object
2 properties 2 required
SettlementDirection
string
Direction of settlement: who owes whom once the commission is finalized.
AuthenticationError
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rye-commissions-api-openapi.yml Raw ↑

Other APIs Rye publishes across the network.

Rye Betas API
Rye Billing API
Rye Brands API
Rye Checkout Intents API
Rye Events API
Rye Merchant Connectors API
Rye Orders API
Rye Payment Gateways API
Rye Products API
Rye Returns API
Rye Shipments API
Rye Test Helpers API
Where this information came from

This is an independent, third-party profile of Rye Commissions 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.