Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 839 Bytes

subscription-action.md

File metadata and controls

29 lines (20 loc) · 839 Bytes

Subscription Action

Represents an action as a pending change to a subscription.

Structure

SubscriptionAction

Fields

Name Type Tags Description
id string | undefined Optional The ID of an action scoped to a subscription.
type string | undefined Optional Supported types of an action as a pending change to a subscription.
effectiveDate string | undefined Optional The YYYY-MM-DD-formatted date when the action occurs on the subscription.
newPlanId string | undefined Optional The target subscription plan a subscription switches to, for a SWAP_PLAN action.

Example (as JSON)

{
  "id": null,
  "type": null,
  "effective_date": null,
  "new_plan_id": null
}