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 Promotion Codes API

A Promotion Code represents a customer-redeemable code for a coupon. It can be used to create multiple codes for a single coupon.

Stripe Promotion Codes API is one of 159 APIs that Stripe publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Codes, Promotion, and Promotions. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 4 operations across 2 paths, and defines 7 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/.

4 operations 2 paths 7 schemas 2 GET2 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 Promotion Codes 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 4

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

Promotion Codes 4
GET
/v1/promotion_codes
Returns a list of your promotion codes.
GetPromotionCodes 9 params body → 200default
POST
/v1/promotion_codes
A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.
PostPromotionCodes body → 200default
GET
/v1/promotion_codes/{promotion_code}
Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use list with the desired code .
GetPromotionCodesPromotionCode 2 params body → 200default
POST
/v1/promotion_codes/{promotion_code}
Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.
PostPromotionCodesPromotionCode 1 param body → 200default

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are promotion_code (13 properties), PostPromotionCodesRequest (9 properties), PromotionCodesResourcePromotionCodeList (4 properties), PostPromotionCodesPromotionCodeRequest (4 properties). Each schema is shown below with its type and property counts.

promotion_code
object
A Promotion Code represents a customer-redeemable code for a [coupon](https://stripe.com/docs/apicoupons). It can be used to create multiple codes for a single…
13 properties 9 required
GetPromotionCodesPromotionCodeRequest
object
PostPromotionCodesPromotionCodeRequest
object
4 properties
PromotionCodesResourcePromotionCodeList
object
4 properties 4 required
error
object
An error response from the Stripe API
1 property 1 required
GetPromotionCodesRequest
object
PostPromotionCodesRequest
object
9 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stripe-promotion-codes-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 Promotion Codes 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.