> ## Documentation Index
> Fetch the complete documentation index at: https://docs.base44.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List Stripe prices
> This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.
Returns prices from every product in the configured Stripe account, unless narrowed to one product with `product_id`. A product can have more than one price, such as separate monthly and annual prices for the same plan.
Uses the Stripe account selected by the app's stored credentials. Live keys select the live catalog and test keys select the test catalog. Products and prices belong to that Stripe account, so multiple apps configured with the same account share the same catalog. Check `livemode` on each returned product or price to see which catalog the call used.
Returns a single batch, with no indication that more results exist. This operation cannot retrieve a complete catalog larger than the requested limit.
Requires read access to the app.
## OpenAPI
````yaml /developers/references/app-management/app-management-openapi.json get /api/apps/{app_id}/payments/stripe/prices
openapi: 3.1.0
info:
title: Base44 App Management API
version: 1.0.0
servers:
- url: https://app.base44.com
security:
- PersonalAccessTokenAuth: []
paths:
/api/apps/{app_id}/payments/stripe/prices:
get:
summary: List Stripe prices
description: >-
This API is in beta. Endpoints, fields, and behavior may still
change, so avoid depending on it in production.
Returns prices from every product in the configured Stripe account,
unless narrowed to one product with `product_id`. A product can have
more than one price, such as separate monthly and annual prices for the
same plan.
Uses the Stripe account selected by the app's stored credentials. Live
keys select the live catalog and test keys select the test catalog.
Products and prices belong to that Stripe account, so multiple apps
configured with the same account share the same catalog. Check
`livemode` on each returned product or price to see which catalog the
call used.
Returns a single batch, with no indication that more results exist. This
operation cannot retrieve a complete catalog larger than the requested
limit.
Requires read access to the app.
operationId: list_prices_api_apps__app_id__payments_stripe_prices_get
parameters:
- name: app_id
in: path
required: true
schema:
type: string
description: ID of the Base44 app.
title: App Id
description: ID of the Base44 app.
example: 6820f3a4e7b91d003c45a1f2
- name: product_id
in: query
required: false
schema:
type: string
description: Stripe product ID to filter by. Defaults to no product filter.
title: Product Id
description: Stripe product ID to filter by. Defaults to no product filter.
example: prod_T7mK2p9Q4r6S8v
- name: active
in: query
required: false
schema:
type: boolean
description: >-
Filter by active status. Stripe defaults to active-only prices
when this is omitted. Pass `false` to list inactive prices
instead.
title: Active
description: >-
Filter by active status. Stripe defaults to active-only prices when
this is omitted. Pass `false` to list inactive prices instead.
example: true
- name: limit
in: query
required: false
schema:
type: integer
maximum: 100
description: >-
Maximum number of prices in this batch. Use 1 through 100.
Defaults to 100. There is no cursor for another batch.
default: 100
title: Limit
description: >-
Maximum number of prices in this batch. Use 1 through 100. Defaults
to 100. There is no cursor for another batch.
example: 25
responses:
'200':
description: The operation result.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/StripeCatalogPrice'
title: >-
Response 200 List Prices Api Apps App Id Payments Stripe
Prices Get
'400':
description: Stripe keys are missing, or the app's test sandbox has expired.
'401':
description: Missing or invalid credentials.
'403':
description: >-
The credential is not permitted or you don't have the required app
access. A missing app also fails the app access check. Setup and
catalog operations also return `app_payment_management_not_allowed`
when the app's workspace restricts payment management.
'404':
description: The app is outside the credential's granted workspace.
'409':
description: The workspace requires an unlocked SSO session.
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- PersonalAccessTokenAuth:
- read_only
components:
schemas:
StripeCatalogPrice:
properties:
id:
type: string
title: Id
description: Stripe price ID.
example: price_1T7mK2Q4r6S8v9Ab
product:
type: string
title: Product
description: Stripe product ID this price belongs to.
example: prod_T7mK2p9Q4r6S8v
unit_amount:
anyOf:
- type: integer
- type: 'null'
title: Unit Amount
description: >-
Amount in the currency's smallest unit, or `null` for pricing
without a fixed integer unit amount.
example: 2500
currency:
type: string
title: Currency
description: Currency as a lowercase three-letter ISO 4217 code.
example: usd
active:
type: boolean
title: Active
description: Whether the price is active.
example: true
metadata:
additionalProperties: true
type: object
title: Metadata
description: Metadata stored on the price.
example:
tier: standard
recurring:
anyOf:
- $ref: '#/components/schemas/StripeCatalogRecurring'
- type: 'null'
description: Billing schedule, or `null` for a one-time price.
example:
interval: month
interval_count: 1
usage_type: licensed
livemode:
type: boolean
title: Livemode
description: >-
`true` when the price is in the live catalog, `false` when it's in
the test catalog.
example: false
type: object
required:
- id
- product
- unit_amount
- currency
- active
- metadata
- recurring
- livemode
title: StripeCatalogPrice
description: A price in the Stripe account configured for the app.
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
StripeCatalogRecurring:
properties:
interval:
type: string
title: Interval
description: Billing interval. Either `day`, `week`, `month`, or `year`.
example: month
interval_count:
type: integer
title: Interval Count
description: Number of intervals between bills.
example: 1
usage_type:
type: string
title: Usage Type
description: Usage model. Either `licensed` or `metered`.
example: licensed
type: object
required:
- interval
- interval_count
- usage_type
title: StripeCatalogRecurring
description: The recurring billing schedule of a Stripe price.
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
securitySchemes:
PersonalAccessTokenAuth:
type: http
scheme: bearer
description: >-
Personal access token, sent as `Authorization: Bearer `. Each
operation lists the permission it needs: `read_only` or `full_access`. A
full-access token can call every operation. A read-only token can call
only the operations that list `read_only`; anything else returns 403
`read_only_credential_route_not_allowed`.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.