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

Stripe Subscription Schedules API

The Subscription Schedules API from Stripe — 4 operation(s) for subscription schedules.

Stripe Subscription Schedules API is one of 159 APIs that Stripe publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

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

This API exposes 6 operations across 4 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 2023-10-16.

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

6 operations 4 paths 11 schemas 2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-10-16
Server
https://api.stripe.com/
Authentication
HTTP Basic, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

Stripe Subscription Schedules API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (auth-scheme) (bearerAuth). By default, every request must be authenticated.

  • basicAuth — Basic HTTP authentication. Allowed headers-- Authorization: Basic | Authorization: Basic
  • bearerAuth — Bearer HTTP authentication. Allowed headers-- Authorization: Bearer

Paths & Operations 6

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

Subscription Schedules 6
GET
/v1/subscription_schedules
Retrieves the list of your subscription schedules.
GetSubscriptionSchedules 10 params body → 200default
POST
/v1/subscription_schedules
Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.
PostSubscriptionSchedules body → 200default
GET
/v1/subscription_schedules/{schedule}
Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.
GetSubscriptionSchedulesSchedule 2 params body → 200default
POST
/v1/subscription_schedules/{schedule}
Updates an existing subscription schedule.
PostSubscriptionSchedulesSchedule 1 param body → 200default
POST
/v1/subscription_schedules/{schedule}/cancel
Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is no…
PostSubscriptionSchedulesScheduleCancel 1 param body → 200default
POST
/v1/subscription_schedules/{schedule}/release
Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is notstarted or…
PostSubscriptionSchedulesScheduleRelease 1 param body → 200default

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are subscription (43 properties), subscription_schedule (18 properties), subscription_item (9 properties), PostSubscriptionSchedulesRequest (8 properties). Each schema is shown below with its type and property counts.

GetSubscriptionSchedulesScheduleRequest
object
subscription_item
object
Subscription items allow you to create customer subscriptions with more than one plan, making it easy to represent complex billing relationships.
9 properties 6 required
SubscriptionSchedulesResourceScheduleList
object
4 properties 4 required
PostSubscriptionSchedulesScheduleCancelRequest
object
3 properties
PostSubscriptionSchedulesScheduleRequest
object
6 properties
error
object
An error response from the Stripe API
1 property 1 required
GetSubscriptionSchedulesRequest
object
PostSubscriptionSchedulesRequest
object
8 properties
PostSubscriptionSchedulesScheduleReleaseRequest
object
2 properties
subscription
object
Subscriptions allow you to charge a customer on a recurring basis. Related guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creati…
43 properties 16 required
subscription_schedule
object
A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes. Related guide: [Subscription schedules…
18 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stripe-subscription-schedules-api-openapi.yml Raw ↑

Other APIs Stripe publishes across the network.

Stripe Accounts API
Stripe Balance API
Stripe Billing API
Stripe Charges API
Stripe Checkout API
Stripe Climate API
Stripe Country API
Stripe Coupons API
Stripe Credit Notes API
Stripe Customers API
Stripe Disputes API
Stripe Ephemeral Keys API
Where this information came from

This is an independent, third-party profile of Stripe Subscription Schedules 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.