Prices

Prices: amount, currency, one-time or recurring.

A price belongs to a product and determines the amount, currency, and whether it's OneTime or Recurring. amount is an integer: for a zero-decimal currency like TWD, amount is the value itself.

GET/api/Price— List prices, optionally filtered by productId

Property	Value
Required scope	`prices:read`
Idempotency-Key	Not required

Parameter	In	Type
`page`	query	integer (int32)
`pageSize`	query	integer (int32)
`orderBy`	query	string
`orderDirection`	query	string
`createdFrom`	query	string (date-time)
`createdTo`	query	string (date-time)
`productId`	query	string

POST/api/Price— Create a new price for a product

Property	Value
Required scope	`prices:write`
Idempotency-Key	Not required

Parameter	In	Type
`active`	body	boolean
`amount`	body	integer (int32)
`currency`	body	string
`interval`	body	string
`intervalCount`	body	integer (int32)
`productId`	body	string
`trialDays`	body	integer (int32)
`type`	body	string

GET/api/Price/{priceId}— Retrieve a single price

Property	Value
Required scope	`prices:read`
Idempotency-Key	Not required

Parameter	In	Type	Required
`priceId`	path	string	Required

PUT/api/Price/{priceId}— 更新價格。

Property	Value
Required scope	`prices:write`
Idempotency-Key	Not required

Parameter	In	Type	Required
`priceId`	path	string	Required
`active`	body	boolean

GET/api/Price/{priceId}/EntitlementPolicy— 價格：EntitlementPolicy。

Property	Value
Required scope	`entitlements:read`
Idempotency-Key	Not required

Parameter	In	Type	Required
`priceId`	path	string	Required
`page`	query	integer (int32)
`pageSize`	query	integer (int32)
`orderBy`	query	string
`orderDirection`	query	string
`createdFrom`	query	string (date-time)
`createdTo`	query	string (date-time)

POST/api/Price/{priceId}/EntitlementPolicy— 價格：EntitlementPolicy。

Property	Value
Required scope	`entitlements:write`
Idempotency-Key	Not required

Parameter	In	Type	Required
`priceId`	path	string	Required
`allowed`	body	string
`creditGrantAmount`	body	integer (int32)
`limit`	body	integer (int32)
`limitAmount`	body	integer (int32)

← Products Customers →