• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
SubscriptionAction BETA

Represents an action as a pending change to a subscription.

Properties

Name Description
id
string

The ID of an action scoped to a subscription.

type
string

The type of the action.

effective_date
string

The YYYY-MM-DD-formatted date when the action occurs on the subscription.

new_plan_id
string

The target subscription plan a subscription switches to, for a SWAP_PLAN action.