v1

latestOpenAPI 3.0.32026-07-26172157253.6 KB

Stripe Payments

Update Stripe Price

Update mutable Stripe price fields, then mirror the price locally after Stripe succeeds.

patch/api/payments/stripe/{environment}/catalog/prices/{priceId}

Path parameters

environment'test' | 'live' required

Payment provider environment.

priceIdstring required

Stripe price ID.

Request body

activeboolean

lookupKeystring nullable

taxBehavior'exclusive' | 'inclusive' | 'unspecified'

metadataMetadata

Response

Price updated

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
  }
}