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

The Billing API from Rye — 6 operation(s) for billing.

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

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

This API exposes 6 operations across 6 paths, and defines 17 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.

6 operations 6 paths 17 schemas 1 DELETE3 GET2 POST

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 Billing 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 6

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

Billing 6
GET
/api/v1/billing/balance
Get drawdown balance
GetBalance → 200401422
GET
/api/v1/billing
Get billing info
GetSettings → 200401422
POST
/api/v1/billing/drawdown
Setup drawdown billing
SetupDrawdown body → 200401422
POST
/api/v1/billing/drawdown/topup
Create on-demand top-up invoice
CreateTopUpInvoice body → 201400401409422503
DELETE
/api/v1/billing/drawdown/topup/{invoiceId}
Cancel top-up invoice
CancelTopUpInvoice 1 param → 204400401404409
GET
/api/v1/billing/transactions
List drawdown transactions
ListTransactions 3 params → 200401422

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Invoice (5 properties), ValidateError (5 properties), TransactionResponse (5 properties), BankTransferDetails (4 properties). Each schema is shown below with its type and property counts.

FieldErrors
object
TransactionResponse
object
5 properties 3 required
DuplicateInvoice
Degraded invoice returned when full details are unavailable (e.g. Stripe fetch failed)
BankTransferDetails
object
Vendor-agnostic bank transfer details for push-based payment
4 properties 4 required
Record_string.string_
object
Construct a type with a set of properties K of type T
ValidateError
object
5 properties 4 required
CreateTopUpParams
object
2 properties 1 required
BalanceResponse
object
2 properties 2 required
Pick_Invoice.Exclude_keyofInvoice.amount-or-bankTransferDetails__
object
From T, pick a set of properties whose keys are in the union K
3 properties 3 required
BillingResponse
object
1 property 1 required
Money
object
2 properties 2 required
SetupDrawdownParams
object
3 properties 2 required
Omit_Invoice.amount-or-bankTransferDetails_
Construct a type with the properties of T except for those in type K.
InvoiceStatus
string
AuthenticationError
object
3 properties 2 required
Invoice
object
5 properties 5 required
TransactionsResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rye-billing-api-openapi.yml Raw ↑

Other APIs Rye publishes across the network.

Rye Betas API
Rye Brands API
Rye Checkout Intents API
Rye Commissions 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 Billing 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.