# Recurly Subscriptions API

**Canonical:** https://apis.io/apis/recurly/recurly-subscriptions-api-api/  
**Provider:** Recurly — https://apis.io/providers/recurly/  
**Base URL:** https://subs.api.recurlycommerce.com  
**Documentation:** https://recurly.com/developers/api/v2021-02-25/index.html

Recurly Subscriptions API is one of 71 APIs that [Recurly](https://apis.io/providers/recurly/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification. This API exposes 17 JSON Schema definitions. Tagged areas include Subscriptions API. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a getting-started guide, a changelog, and 17 JSON Schemas.

The Subscriptions API API from Recurly — 17 operation(s) for subscriptions api.

## Operations (19)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1/subscriptions` | List Subscriptions |
| POST | `/api/v1/subscriptions` | Create Subscription |
| GET | `/api/v1/subscriptions/count` | Get Subscriptions Count |
| GET | `/api/v1/subscriptions/{id}` | Get Subscription |
| GET | `/api/v1/subscriptions/{id}/billingDeliveryCadenceUpdatePreview` | Get Subscription Billing Delivery Cadence Update Preview |
| PATCH | `/api/v1/subscriptions/{id}/status` | Update Subscription Status |
| PATCH | `/api/v1/subscriptions/{id}/paymentMethod` | Update Subscription Payment Method |
| POST | `/api/v1/subscriptions/{id}/discountCodes/{code}` | Apply Subscription Discount Code |
| DELETE | `/api/v1/subscriptions/{id}/discountCodes/{code}` | Remove Subscription Discount Code |
| PATCH | `/api/v1/subscriptions/{id}/billingDeliveryCadence` | Update Billing Delivery Cadence |
| PATCH | `/api/v1/subscriptions/{id}/deliveryAddress` | Update Subscription Delivery Address |
| PATCH | `/api/v1/subscriptions/{id}/deliveryShippingOption` | Update Subscription Delivery Shipping Option |
| PATCH | `/api/v1/subscriptions/{id}/subscriptionOfferOption` | Update Subscription Offer Option |
| PATCH | `/api/v1/subscriptions/{id}/customAttributes` | Update Subscription Custom Attributes |
| GET | `/api/v1/subscriptions/{id}/billingAttempts` | Get Billing Attempts By Subscription Id |
| GET | `/api/v1/subscriptions/{id}/billingAttempts/count` | Get Billing Attempts Count By Subscription Id |
| PATCH | `/api/v1/subscriptions/{id}/nextBillingAndDeliveryDate` | Update Subscription Next Billing And Delivery Date |
| PATCH | `/api/v1/subscriptions/{id}/upcomingOrders/{date}/skip` | Skip Upcoming Order |
| GET | `/api/v1/subscriptions/{id}/swapAndAddOnOptions` | List Subscription Swap And Add On Options |

## Machine-readable artifacts (32)

- **OpenAPI** — https://artifacts.apis.io/recurly/openapi/recurly-subscriptions-api-api-openapi.yml
- **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
- **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
- **AsyncAPI** — https://artifacts.apis.io/recurly/asyncapi.yml
- **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
- **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
- **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
- **Documentation** — https://docs.recurly.com/recurly-recover/docs/getting-started
- **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
- **Documentation** — https://docs.recurly.com/recurly-revrec/docs/getting-started
- **Documentation** — https://docs.recurly.com/recurly-engage/docs/recurly-engage-sdk

## Other Recurly APIs (12)

- [Recurly Compass MCP server](https://apis.io/apis/recurly/recurly-compass-mcp-server/)
- [Recurly Account Acquisition Info API](https://apis.io/apis/recurly/recurly-account-acquisition-info-api/)
- [Recurly Account API](https://apis.io/apis/recurly/recurly-account-api/)
- [Recurly Account Note API](https://apis.io/apis/recurly/recurly-account-note-api/)
- [Recurly Accounts API](https://apis.io/apis/recurly/recurly-accounts-api/)
- [Recurly Add On API](https://apis.io/apis/recurly/recurly-add-on-api/)
- [Recurly Adjustments API](https://apis.io/apis/recurly/recurly-adjustments-api/)
- [Recurly Automated Exports API](https://apis.io/apis/recurly/recurly-automated-exports-api/)
- [Recurly BaseOrderLineItems API](https://apis.io/apis/recurly/recurly-baseorderlineitems-api-api/)
- [Recurly BaseOrders API](https://apis.io/apis/recurly/recurly-baseorders-api-api/)
- [Recurly Billing Info API](https://apis.io/apis/recurly/recurly-billing-info-api/)
- [Recurly Billing Infos API](https://apis.io/apis/recurly/recurly-billing-infos-api/)

## Tags

Subscriptions API

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/recurly/recurly-subscriptions-api-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/recurly/.
