IDidealspot

List Stripe prices

Changed on

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

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.

get/api/apps/{app_id}/payments/stripe/prices

Request

  • Base URL
    https://app.base44.com
  • URL
    https://app.base44.com/api/apps/{app_id}/payments/stripe/prices
  • Auth
    HTTP bearer

Path parameters

app_idstring required

ID of the Base44 app.

Query parameters

product_idstring

Stripe product ID to filter by. Defaults to no product filter.

activeboolean

Filter by active status. Stripe defaults to active-only prices when this is omitted. Pass false to list inactive prices instead.

limitinteger

Maximum number of prices in this batch. Use 1 through 100. Defaults to 100. There is no cursor for another batch.

Response

The operation result.

idstring required

Stripe price ID.

productstring required

Stripe product ID this price belongs to.

unit_amountinteger nullable required

Amount in the currency's smallest unit, or null for pricing without a fixed integer unit amount.

currencystring required

Currency as a lowercase three-letter ISO 4217 code.

activeboolean required

Whether the price is active.

metadataobject required

Metadata stored on the price.

livemodeboolean required

true when the price is in the live catalog, false when it's in the test catalog.

Example response

[
  {
    "id": "price_1T7mK2Q4r6S8v9Ab",
    "product": "prod_T7mK2p9Q4r6S8v",
    "unit_amount": 2500,
    "currency": "usd",
    "active": true,
    "metadata": {
      "tier": "standard"
    },
    "recurring": {
      "interval": "month",
      "interval_count": 1,
      "usage_type": "licensed"
    }
  }
]

Changes

  • c23775445de2Revision changes
    • breaking

      query request parameter active list-of-types was narrowed by removing types null

    • breaking

      query request parameter product_id list-of-types was narrowed by removing types null

    • breaking

      for the query request parameter active, the type changed from no type to boolean

    • info

      for the query request parameter product_id, the type was generalized from no type to string

  • 06cfcce0bdd9Revision changes
    • info

      the security scope read_only was added to the endpoint's security scheme PersonalAccessTokenAuth

    • info

      the security scope full_access was removed from the endpoint's security scheme PersonalAccessTokenAuth