<- Object

Object

All versions ->

SubscriptionEvent

Describes changes to a subscription and the subscription status.

Link to section

Properties

Link to section

id

string

Required

The ID of the subscription event.

Link to section

subscription_event_type

string

Required

Type of the subscription event.

Link to section

effective_date

string

Required

The YYYY-MM-DD-formatted date (for example, 2013-01-15) when the subscription event occurred.

Link to section

monthly_billing_anchor_date

integer(32-bit)

Beta

Read only The day-of-the-month the billing anchor date was changed to, if applicable.

Link to section

info

Additional information about the subscription event.

Link to section

phases

A list of Phases, to pass phase-specific information used in the swap.

Link to section

plan_variation_id

string

Required

The ID of the subscription plan variation associated with the subscription.