Recurly

Recurly Purchase API

A purchase is a checkout containing at least one or more subscriptions or one-time charges (line items) and supports both coupon and gift card redemptions. All items purchased will be on one invoice and paid for with one transaction. The purchases endpoint can also be used to immediately create a credit invoice on an account, when Credit Invoices is enabled on your site.

GitHub OpenAPI
Business capability
Payment Collection & Dunning BC-4250.40

Operations 6

POST /purchases Create a new purchase #
POST /purchases/preview Preview a new purchase #
POST /purchases/pending Create a pending purchase #
POST /purchases/authorize Authorize a purchase #
POST /purchases/{transaction_id}/capture Capture a purchase #
POST /purchases/{transaction_id}/cancel/ Cancel Purchase #

Documentation

📖
Documentation
https://docs.recurly.com/recurly-subscriptions/docs/integration-paths
📖
APIReference
https://recurly.com/developers/api/v2021-02-25/index.html
📖
Authentication
https://docs.recurly.com/recurly-subscriptions/docs/api-keys
📖
GettingStarted
https://docs.recurly.com/recurly-subscriptions/docs/quick-start-guide
📖
APIReference
https://recurly.com/developers/api-v2/v2.29/index.html
📖
Documentation
https://docs.recurly.com/recurly-subscriptions/docs/upgrade-to-api-v3
📖
Documentation
https://docs.recurly.com/recurly-commerce/docs/getting-started
📖
Documentation
https://docs.recurly.com/recurly-recover/docs/getting-started
📖
Documentation
https://docs.recurly.com/recurly-revrec/docs/getting-started
📖
Documentation
https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk

Specifications

⚙
OpenAPI
https://artifacts.apis.io/recurly/openapi/recurly-purchase-api-openapi.yml
⚙
AsyncAPI
https://artifacts.apis.io/recurly/asyncapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-line-item-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-subscription-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-invoice-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-subscription-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-add-on-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-purchase-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-subscription-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-billing-attempt-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-subscription-create-request-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-subscription-line-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-subscription-offer-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-subscriber-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-transaction-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-recovery-invoice-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-dunning-campaign-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-invoice-collection-schema.json
📊
JSONSchema
https://artifacts.apis.io/recurly/json-schema/recurly-dunning-campaign-list-schema.json

Other Resources

🔗
Webhooks
https://docs.recurly.com/recurly-subscriptions/docs/overview-webhooks
🔗
ChangeLog
https://recurly.com/developers/api/changelog.html
🔗
SourceCode
https://github.com/recurly/recurly-client-spec

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/recurly:recurly-purchase-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

recurly-purchase-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Recurly Purchase API
  version: v2021-02-25
  description: 'Operations tagged Purchase across 2 of this provider''s published API definitions: recurly-v3-v2021-02-25-api.yaml, recurly-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://v3.recurly.com
- url: https://v3.eu.recurly.com
security:
- api_key: []
tags:


# --- truncated at 32 KB (181 KB total) ---
# Full source: https://artifacts.apis.io/recurly/openapi/recurly-purchase-api-openapi.yml