Skip to main content
POST
Set a customer rate card

Authorizations

Authorization
string
header
required

Your account's secret key: Authorization: Bearer sk_test_… or sk_live_…. Server-side only.

Headers

Idempotency-Key
string

A unique key per operation (a UUID works). Retrying with the same key returns the original response.

Path Parameters

customerID
string<uuid>
required

ID of the customer's enrollment in the product (not the customer ID).

Body

application/json
meterId
string<uuid> | null
required

The meter whose price you want to override. Send null for the recurring base fee, which must use model: flat.

model
enum<string>
required

Pricing model.

Available options:
flat,
per_unit,
tiered,
volume,
package
unitAmount
string | null

Price per unit, as a decimal string.

tiers
any
default:[]

Price tiers, for tiered, volume and package.

currency
string

Currency (for example BRL).

Example:

"BRL"

Response

Rate card set.

id
string<uuid>
customerId
string<uuid>

Enrollment ID.

meterId
string<uuid> | null

The meter whose price is overridden. Null when it overrides the recurring base fee.

model
enum<string>

Pricing model.

Available options:
flat,
per_unit,
tiered,
volume,
package
unitAmount
string | null

Price per unit, as a decimal string.

tiers
object[]

Price tiers, for tiered, volume and package.

currency
string