Schema2020-08-27object

portal_subscription_update

Source: openapi/spec3.json
Commit: d70de345383d
Active snapshot: da69df7e6e11

PortalSubscriptionUpdate

object

default_allowed_updates array

required

The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable.

enabled boolean

required

Whether the feature is enabled.

products array

optionalnullable

The list of products that support subscription updates.

proration_behavior string

required

Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.

Allowed: "always_invoice""create_prorations""none"

Root JSON Schema

{"properties":{"default_allowed_updates":{"description":"The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable.","items":{"enum":["price","promotion_code","quantity"],"type":"string"},"type":"array"},"enabled":{"description":"Whether the feature is enabled.","type":"boolean"},"products":{"description":"The list of products that support subscription updates.","items":{"$ref":"#/components/schemas/portal_subscription_update_product"},"nullable":true,"type":"array"},"proration_behavior":{"description":"Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.","enum":["always_invoice","create_prorations","none"],"type":"string"}},"required":["default_allowed_updates","enabled","proration_behavior"],"title":"PortalSubscriptionUpdate","type":"object","x-expandableFields":["products"]}