Skip to main content
POST
Preview a plan change (v2, swap in place)

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

id
string
required

Subscription ID

Body

application/json

Plan change request

proration_behavior
enum<string>
required
Available options:
create_prorations,
none
target_plan_id
string
required
entity_policies
object
idempotency_key
string
metadata
object

Response

OK

change_type
enum<string>
Available options:
upgrade,
downgrade,
lateral
changed_resources
object
effective_at
string<date-time>
entity_changes
object[]
from_plan
object
metadata
object
subscription
object
to_plan
object
warnings
string[]