Sign in
Subscriptions

Preview the effect of a subscription update

Changed on
put/subscriptions/{subscription_id}/preview

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

typestring

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

Example response

{
  "exceeded_quotas": [
    {
      "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

    • warning

      added the new runs_per_study enum value to the ///// response property for the response status

  • be42c3cf5190Revision changes
    • info

      endpoint added