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

The Subscriptions API from Stripe — 8 operation(s) for subscriptions.

Stripe Subscriptions 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. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 15 operations across 8 paths, and defines 31 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/.

15 operations 8 paths 31 schemas 4 DELETE6 GET5 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 Subscriptions 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 15

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

Subscriptions 15
GET
/v1/customers/{customer}/subscriptions
Stripe Get Customers Customer Subscriptions
getCustomersCustomerSubscriptions 5 params body → 200default
POST
/v1/customers/{customer}/subscriptions
Stripe Post Customers Customer Subscriptions
postCustomersCustomerSubscriptions 1 param body → 200default
DELETE
/v1/customers/{customer}/subscriptions/{subscription_exposed_id}
Stripe Delete Customers Customer Subscriptions Subscription Exposed Id
deleteCustomersCustomerSubscriptionsSubscriptionExposedId 2 params body → 200default
GET
/v1/customers/{customer}/subscriptions/{subscription_exposed_id}
Stripe Get Customers Customer Subscriptions Subscription Exposed Id
getCustomersCustomerSubscriptionsSubscriptionExposedId 3 params body → 200default
POST
/v1/customers/{customer}/subscriptions/{subscription_exposed_id}
Stripe Post Customers Customer Subscriptions Subscription Exposed Id
postCustomersCustomerSubscriptionsSubscriptionExposedId 2 params body → 200default
DELETE
/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount
Stripe Delete Customers Customer Subscriptions Subscription Exposed Id Discount
deleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount 2 params body → 200default
GET
/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount
Stripe Get Customers Customer Subscriptions Subscription Exposed Id Discount
getCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount 3 params body → 200default
GET
/v1/subscriptions
By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled .
GetSubscriptions 13 params body → 200default
POST
/v1/subscriptions
Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions. When you create a subscription with collectionmethod=chargeautomatically , the…
PostSubscriptions body → 200default
GET
/v1/subscriptions/search
Search for subscriptions you’ve previously created using Stripe’s Search Query Language . Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating cond…
GetSubscriptionsSearch 4 params body → 200default
DELETE
/v1/subscriptions/{subscription_exposed_id}
Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription. Note, however, that any pending invoice items that you’ve created will still be charged for…
DeleteSubscriptionsSubscriptionExposedId 1 param body → 200default
GET
/v1/subscriptions/{subscription_exposed_id}
Retrieves the subscription with the given ID.
GetSubscriptionsSubscriptionExposedId 2 params body → 200default
POST
/v1/subscriptions/{subscription_exposed_id}
Updates an existing subscription to match the specified parameters. When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes. To previ…
PostSubscriptionsSubscriptionExposedId 1 param body → 200default
DELETE
/v1/subscriptions/{subscription_exposed_id}/discount
Removes the currently applied discount on a subscription.
DeleteSubscriptionsSubscriptionExposedIdDiscount 1 param body → 200default
POST
/v1/subscriptions/{subscription}/resume
Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible bef…
PostSubscriptionsSubscriptionResume 1 param body → 200default

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are payment_method (43 properties), subscription (43 properties), PostSubscriptionsRequest (32 properties), PostSubscriptionsSubscriptionExposedIdRequest (31 properties). Each schema is shown below with its type and property counts.

customer
object
This object represents a customer of your business. Use it to create recurring charges and track payments that belong to the same customer. Related guide: [Sav…
28 properties 4 required
SearchResult
object
6 properties 4 required
PostSubscriptionsSubscriptionExposedIdRequest
object
31 properties
payment_method
object
PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) t…
43 properties 6 required
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
GetCustomersCustomerSubscriptionsRequest
object
deleted_customer
object
3 properties 3 required
card
object
You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer t…
28 properties 7 required
GetCustomersCustomerSubscriptionsSubscriptionExposedIdRequest
object
tax_id
object
You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account. Customer and account tax IDs get displayed on related in…
9 properties 6 required
PostCustomersCustomerSubscriptionsRequest
object
29 properties
GetSubscriptionsSubscriptionExposedIdRequest
object
GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscountRequest
object
PostSubscriptionsSubscriptionResumeRequest
object
4 properties
DeleteSubscriptionsSubscriptionExposedIdDiscountRequest
object
SubscriptionsSubscriptionList
object
4 properties 4 required
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
error
object
An error response from the Stripe API
1 property 1 required
DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequest
object
3 properties
bank_account
object
These bank accounts are payment methods on Customer objects. On the other hand [External Accounts](https://stripe.com/docs/apiexternalaccounts) are transfer de…
19 properties 6 required
GetSubscriptionsSearchRequest
object
SubscriptionList
object
4 properties 4 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
DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscountRequest
object
deleted_discount
object
11 properties 5 required
PostSubscriptionsRequest
object
32 properties 1 required
DeleteSubscriptionsSubscriptionExposedIdRequest
object
4 properties
discount
object
A discount represents the actual application of a [coupon](https://stripe.com/docs/apicoupons) or [promotion code](https://stripe.com/docs/apipromotioncodes).…
11 properties 4 required
cash_balance
object
A customer's Cash balance represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment…
5 properties 4 required
GetSubscriptionsRequest
object
PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequest
object
29 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stripe-subscriptions-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 Subscriptions 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.