v51

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-01169142751.2 KB

Subscriptions - Essentials

Update Essentials subscription

Updates the specified Essentials subscription.

put/v1/fixed/subscriptions/{subscriptionId}

Path parameters

subscriptionIdinteger required

Request body

subscriptionIdinteger

namestring

Optional. Updated subscription name.

planIdinteger

Optional. An Essentials plan ID. The plan describes the dataset size, cloud provider and region, and available database configuration options. Use GET /fixed/plans/subscriptions/{subscriptionId} to get a list of compatible options for the specified subscription.

paymentMethod'credit-card' | 'marketplace'

Optional. The payment method for the subscription. If set to ‘credit-card’ , ‘paymentMethodId’ must be defined.

paymentMethodIdinteger

Optional. The payment method ID you'd like to use for this subscription. Must be a valid payment method ID for this account. Use GET /payment-methods to get a list of payment methods for your account. This value is optional if ‘paymentMethod’ is ‘marketplace’, but required if 'paymentMethod' is 'credit-card'.

commandTypestring

Example request

{
  "name": "My new subscription"
}

Response

Accepted

taskIdstring uuid

commandTypestring

status'initialized' | 'received' | 'processing-in-progress' | 'processing-completed' | 'processing-error'

descriptionstring

timestampstring date-time

linksobject[]