Subscriptions

Update a subscription

Changed on
put/subscriptions/{subscription_id}

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in header x-pollination-token

Path parameters

subscription_idstring uuid required

Request body

typestring

A base class to use when there is no baseclass available to fall on.

plan_idinteger

The Paddle Plan ID to change the subscription to.

quantityinteger

The number of times this subscription is purchased

Response

Successful Response

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

An enumeration.

idstring uuid required

The unique ID of this subscription

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

external_idstring

The ID of 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!"
  }
}

Changes

  • e25504ef9dccRevision changes
    • breaking

      response property detail/items/loc/items/ list-of-types was widened by adding types integer to media type application/json of response 422

    • warning

      the / request property's min was set to 1.00

  • be42c3cf5190Revision changes
    • info

      endpoint added