Skip to main content
GET
Preview Subscription Quantity
Read-only preview of the estimated amount for the next cycle at a given quantity, intended to be shown before a seat change. Only supported for active subscriptions with billing_dimension=quantity. Has no side effects.

Authorizations

Authorization
string
header
required

Bearer API Key authentication. Format: Authorization: Bearer {your_api_key}

Headers

Request-Id
string
default:008e3967-a1b5-48bb-be14-d5bff5092e61
required

The unique identifier of the request

Path Parameters

subscription_id
string
required

Subscription ID (path)

Query Parameters

quantity
string
required

Target quantity to preview (query, 1-999999999)

Response

OK

Quantity change preview response

code
string

error code

message
string

error message

data
object

Quantity change preview response