Sign in
Prices

Update a price.

patch/v2/prices/{price_id}

Path parameters

price_idstring required

Request body

product_idstring

LedgerUp resource identifier.

stripe_price_idstring nullable
billing_mode'flat' | 'per_unit' | 'per_seat' | 'usage_sum' | 'last_metric_reported' | 'tiered_usage' | 'package' | 'minimum_commit'

How a price or rate converts a contract line into invoice amount.

currency_codestring
interval'month' | 'quarter' | 'year' | 'one_time' | 'contract_term'

How often the line is evaluated for billing.

unit_amount_minor_unitsinteger nullable
unit_scalestring nullable
{"stackTrail":"components:schemas:Properties","oasType":"schema","type":"unknown","description":"Arbitrary JSON object or value. If omitted on write endpoints, the service stores an empty object."}

Example request

{
  "billing_mode": "last_metric_reported",
  "interval": "month"
}

Response

Success.

idstring required

LedgerUp resource identifier.

product_idstring required

LedgerUp resource identifier.

stripe_price_idstring nullable required
billing_mode'flat' | 'per_unit' | 'per_seat' | 'usage_sum' | 'last_metric_reported' | 'tiered_usage' | 'package' | 'minimum_commit' required

How a price or rate converts a contract line into invoice amount.

currency_codestring required
interval'month' | 'quarter' | 'year' | 'one_time' | 'contract_term' required

How often the line is evaluated for billing.

unit_amount_minor_unitsinteger nullable required
unit_scalestring nullable required
{"stackTrail":"components:schemas:Properties","oasType":"schema","type":"unknown","description":"Arbitrary JSON object or value. If omitted on write endpoints, the service stores an empty object."}
created_atinteger required

Unix timestamp in seconds.

updated_atinteger required

Unix timestamp in seconds.

archived_atinteger required

Unix timestamp in seconds.

Example response

{
  "stripe_price_id": "price_123",
  "billing_mode": "last_metric_reported",
  "currency_code": "USD",
  "interval": "month",
  "created_at": 1767225600,
  "updated_at": 1767225600,
  "archived_at": 1767225600
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.