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 Billing Portal API

The Billing Portal API from Stripe — 3 operation(s) for billing portal.

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

This API exposes 5 operations across 3 paths, and defines 9 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/.

5 operations 3 paths 9 schemas 2 GET3 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 Billing Portal 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 5

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

Billing Portal 5
GET
/v1/billing_portal/configurations
Returns a list of configurations that describe the functionality of the customer portal.
GetBillingPortalConfigurations 6 params body → 200default
POST
/v1/billing_portal/configurations
Creates a configuration that describes the functionality and behavior of a PortalSession
PostBillingPortalConfigurations body → 200default
GET
/v1/billing_portal/configurations/{configuration}
Retrieves a configuration that describes the functionality of the customer portal.
GetBillingPortalConfigurationsConfiguration 2 params body → 200default
POST
/v1/billing_portal/configurations/{configuration}
Updates a configuration that describes the functionality of the customer portal.
PostBillingPortalConfigurationsConfiguration 1 param body → 200default
POST
/v1/billing_portal/sessions
Creates a session of the customer portal.
PostBillingPortalSessions body → 200default

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are billing_portal.configuration (13 properties), billing_portal.session (11 properties), PostBillingPortalSessionsRequest (7 properties), PostBillingPortalConfigurationsConfigurationRequest (7 properties). Each schema is shown below with its type and property counts.

billing_portal.configuration
object
A portal configuration describes the functionality and behavior of a portal session.
13 properties 10 required
PostBillingPortalSessionsRequest
object
7 properties 1 required
GetBillingPortalConfigurationsRequest
object
billing_portal.session
object
The Billing customer portal is a Stripe-hosted UI for subscription and billing management. A portal configuration describes the functionality and features that…
11 properties 7 required
PortalPublicResourceConfigurationList
object
4 properties 4 required
error
object
An error response from the Stripe API
1 property 1 required
PostBillingPortalConfigurationsRequest
object
6 properties 2 required
PostBillingPortalConfigurationsConfigurationRequest
object
7 properties
GetBillingPortalConfigurationsConfigurationRequest
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stripe-billing-portal-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 Billing Portal 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.