Sign in

v1

latestOpenAPI 3.0.32026-07-26172157253.6 KB
Stripe Payments

Create Stripe Price

Create a Stripe price in the requested environment, then mirror it locally after Stripe succeeds.

post/api/payments/stripe/{environment}/catalog/prices

Path parameters

environment'test' | 'live' required

Payment provider environment.

Request body

productIdstring required
currencystring required
unitAmountinteger required
lookupKeystring nullable
activeboolean
taxBehavior'exclusive' | 'inclusive' | 'unspecified'
metadataMetadata
idempotencyKeystring

Example request

{
  "currency": "usd",
  "unitAmount": 2900
}

Response

Price created

Example response

{
  "price": {
    "priceId": "price_123",
    "productId": "prod_123",
    "currency": "usd",
    "unitAmount": 2900,
    "unitAmountDecimal": "2900",
    "type": "recurring",
    "lookupKey": "pro_monthly",
    "billingScheme": "per_unit",
    "taxBehavior": "unspecified",
    "recurringInterval": "month",
    "recurringIntervalCount": 1
  }
}