Skip to main content
POST
Price a plan or quantity change

Authorizations

X-Suby-Api-Key
string
header
required

Secret API key. sk_live_… (production) or sk_sandbox_… (sandbox).

Path Parameters

id
string
required
Example:

"sub_abc123"

Body

application/json

productId, quantity, or both.

productId
string

Target plan. Omitted = current plan.

Example:

"pro_9m2k1x8s7d6f"

quantity
integer

Units to hold afterwards (absolute, not a delta).

Required range: 1 <= x <= 999
Example:

3

effective
enum<string>
default:auto

auto: increase now, decrease at period end.

Available options:
auto,
now,
period_end
proration
enum<string>
default:delta

delta charges the prorated difference; none charges nothing.

Available options:
delta,
none

Response

The change, priced

success
boolean
required
Example:

true

data
object
required

Endpoint-specific payload.

message
string