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

Recharge Orders API

Orders generated from charges, plus one-time and recurring order management.

Recharge Orders API is one of 10 APIs that Recharge publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 6 operations across 4 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 2021-11.

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

6 operations 4 paths 1 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2021-11
Base URL
https://api.rechargeapps.com
Authentication
API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Recharge Orders API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Recharge-Access-Token (apiToken). By default, every request must be authenticated.

  • apiToken — Store API token generated in the Recharge merchant portal under Apps and integrations.

Paths & Operations 6

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

Orders 6

Orders generated from charges, plus one-time and recurring order management.

GET
/orders
List orders
listOrders 2 params → 200
GET
/orders/{id}
Retrieve an order
getOrder 1 param → 200
PUT
/orders/{id}
Update an order
updateOrder 1 param → 200
DELETE
/orders/{id}
Delete an order
deleteOrder 1 param → 204
POST
/orders/{id}/clone
Clone an order
cloneOrder 1 param → 201
POST
/orders/{id}/delay
Delay an order
delayOrder 1 param → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Order (7 properties). Each schema is shown below with its type and property counts.

Order
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

recharge-payments-orders-api-openapi.yml Raw ↑

Other APIs Recharge publishes across the network.

Recharge Addresses API
Recharge Charges API
Recharge Customers API
Recharge Discounts API
Recharge Onetimes API
Recharge Payment Methods API
Recharge Products API
Recharge Subscriptions API
Recharge Webhooks API