Skip to content

List a product's Stripe prices โ€‹

GET /v1/admin/plans/products/{id}/prices

  • Operation ID: listPlanProductPrices
  • Tags: Plans and pricing
  • Base URL: http://localhost:8787

Prices of the linked Stripe product from the synced stripe.prices table. Empty when the product is not linked to Stripe or the sync tables do not exist.

Workflow: Integration guide.

Authentication: staff Bearer JWT with permission plans.read.

Authentication โ€‹

  • Auth: staff Bearer JWT (Authorization: Bearer <access_token>) with the permissions below.
  • Required permissions: plans.read

Parameters โ€‹

NameInTypeRequiredDescription
idpathstring<uuid>yes-

Responses โ€‹

200 โ€‹

Prices.

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object

FieldTypeRequiredDescription
data(object (PlansPrice))[]yes-
data[].idstringyes-
data[].currencystring | nullyes-
data[].unit_amountstring | nullyesMinor units, as a string.
data[].activeboolean | nullyes-
data[].recurring_intervalstring | nullyes-
data[].is_defaultbooleanyesWhether this is the product's default Stripe price.

Errors โ€‹

400 โ€‹

Request validation failed.

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ValidationErrorBody)

FieldTypeRequiredDescription
successbooleanyesOne of: false
errorobjectyes-
error.namestringyesOne of: "ZodError"
error.issuesobject[]yes-
error.issues[].codestringyes-
error.issues[].path(string | number)[]yes-
error.issues[].messagestringyes-

Request validation

json
{
  "success": false,
  "error": {
    "name": "ZodError",
    "issues": [
      {
        "code": "custom",
        "path": [
          "field"
        ],
        "message": "Invalid value"
      }
    ]
  }
}

401 โ€‹

Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody)

FieldTypeRequiredDescription
errorstringyesStable machine-readable error code, e.g. forbidden, not_found.
detailsanynoOptional structured context. For 403 it is { perm }.

Error response

json
{
  "error": "missing_token"
}

403 โ€‹

Authenticated but lacking the required permission. details.perm lists the accepted permission keys.

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

json
{
  "error": "forbidden",
  "details": {
    "perm": "plans.read"
  }
}

404 โ€‹

product: no product with this id.

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

json
{
  "error": "product"
}

500 โ€‹

Unexpected server error (internal). No details are returned.

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

json
{
  "error": "internal"
}

Examples โ€‹

curl โ€‹

bash
curl -X GET 'http://localhost:8787/v1/admin/plans/products/3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90/prices' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

TypeScript โ€‹

ts
const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow

const response = await fetch("http://localhost:8787/v1/admin/plans/products/3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90/prices", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
  },
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
  ? undefined
  : response.headers.get("content-type")?.includes("json")
    ? await response.json()
    : await response.text();

Try this endpoint

Requests go directly from your browser to the API. Send request executes this endpoint against the selected server.

GET/v1/admin/plans/products/{id}/prices

Your token stays in this tab's memory and is sent only when you press Send request.

Parameters

Built for developers. Ready for agents.