Sign in
organizations

Changed on

GET /…/subscription/ → current state. POST upgrade action.

post/v1/organizations/billing/subscription/upgrade/

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in cookie sessionid
    • API key in header X-Session-Token

Headers

Vellum-Organization-Idstring uuid

Required if using Cookie-based or X-Session-Token authentication methods.

Request body

packagestring nullable
target_plan_id'base' | 'pro' required
  • base - base
  • pro - pro
confirmboolean required
include_platform_feeboolean
return_target'web' | 'native'
  • web - web
  • native - native

Response

status'redirect' | 'no_op' required
  • redirect - redirect
  • no_op - no_op
checkout_urlstring nullable required
messagestring required

Changes

  • d3629dcc91d8Revision changes
    • ○

      added the new optional request property (media type: application/json)

    • ○

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • ○

      added the new optional request property (media type: multipart/form-data)

  • 6f1e97f84ad2Revision changes
    • ▲

      removed the enum value l of the request property (media type: application/json)

    • ▲

      removed the enum value l of the request property (media type: application/x-www-form-urlencoded)

    • ▲

      removed the enum value l of the request property (media type: multipart/form-data)

    • ▲

      removed the enum value m of the request property (media type: application/json)

    • ▲

      removed the enum value m of the request property (media type: application/x-www-form-urlencoded)

    • ▲

      removed the enum value m of the request property (media type: multipart/form-data)

    • ▲

      removed the enum value s of the request property (media type: application/json)

    • ▲

      removed the enum value s of the request property (media type: application/x-www-form-urlencoded)

    • ▲

      removed the enum value s of the request property (media type: multipart/form-data)

    • ▲

      removed the enum value xl of the request property (media type: application/json)

    • ▲

      removed the enum value xl of the request property (media type: application/x-www-form-urlencoded)

    • ▲

      removed the enum value xl of the request property (media type: multipart/form-data)

    • ▲

      removed the enum value xs of the request property (media type: application/json)

    • ▲

      removed the enum value xs of the request property (media type: application/x-www-form-urlencoded)

    • ▲

      removed the enum value xs of the request property (media type: multipart/form-data)

    • ▲

      removed the enum value xxl of the request property (media type: application/json)

    • ▲

      removed the enum value xxl of the request property (media type: application/x-www-form-urlencoded)

    • ▲

      removed the enum value xxl of the request property (media type: multipart/form-data)

    • ▲

      the request property type changed from string to no type (media type: application/json)

    • ○

      added the new optional request property (media type: application/json)

    • ○

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • ○

      added the new optional request property (media type: multipart/form-data)

    • ○

      the request property became nullable (media type: application/json)

    • ○

      the request property became nullable (media type: application/x-www-form-urlencoded)

    • ○

      the request property became nullable (media type: multipart/form-data)

    • ○

      the request property became optional (media type: application/json)

    • ○

      the request property became optional (media type: application/x-www-form-urlencoded)

    • ○

      the request property became optional (media type: multipart/form-data)

    • ○

      added to the request property oneOf list (media type: application/json)

    • ○

      added to the request property oneOf list (media type: application/x-www-form-urlencoded)

    • ○

      added to the request property oneOf list (media type: multipart/form-data)

    • ○

      the request property type was generalized from string to no type (media type: application/x-www-form-urlencoded)

    • ○

      the request property type was generalized from string to no type (media type: multipart/form-data)