SubscriptionCycle1

Known details for one completed or scheduled subscription cycle.

Every cycle requires billed_at. Send a stable id when available, especially for scheduled cycles whose billing time may change.

A completed cycle was successfully billed. A scheduled cycle is expected but has not been successfully billed yet.

Kind	Type
Used in	UpdateSubscriptions1

Properties

• id string optional

  Stable cycle or billing ID in your system.

• state SubscriptionCycleState1 optional

  Whether this cycle completed successfully or remains scheduled.

  When omitted, Bubblehouse compares billed_at with the subscription snapshot's updated_at: later cycles are scheduled, while cycles at or before it are completed.

• billed_at time required

  Actual successful billing time for a completed cycle, or expected billing time for a scheduled cycle.

• start_at time optional

  Start of the cycle period, when known.

• end_at time optional

  End of the cycle period, when known.

• amount monetary optional

  Successfully billed or expected cycle amount, when known.

• discount_codes array of string optional

  Coupon codes used or expected for this cycle.

  Include these only when the same codes are not sent on the matching order.