Sign in
latestOpenAPI 3.1.02026-08-10150311431.9 KB

c1f3c6d96b31

Subscriptions

Update a subscription

put/subscriptions/{subscription_id}

Path parameters

subscription_idstring uuid required

Request body

plan_idinteger

The Paddle Plan ID to change the subscription to.

quantityinteger

The number of times this subscription is purchased

Response

Successful Response

idstring uuid required

The unique ID of this subscription

external_idstring

The ID of this subscription

type'cloud' | 'rhino-plugin' | 'revit-plugin' | 'bundled-plugin' | 'application' | 'seat' | 'cloud-compute' required

An enumeration.

period_startstring date-time required

The start of the current subscription period

period_endstring date-time required

The end of the current subscription period

plan_slugstring required

The slug of the plan used to create this subscription

plan_multiplierinteger

The number of times to multiply the plan limit by

Example response

{
  "owner": {
    "id": "0ad77f99-8043-46e4-8220-7221487c3ee5",
    "account_type": "user",
    "name": "ladybugbot",
    "display_name": "Ladybug Bot",
    "description": "Beep Boop!"
  }
}