4.3 KiB
4.3 KiB
CreateEntitySubscription
Fields
| Field | Type | Required | Description |
|---|---|---|---|
plan |
Optional[models.Plan] | ➖ | N/A |
plan_id |
str | ✔️ | The unique identifier of the subscribed plan. |
auto_enable |
bool | ✔️ | Whether the plan was automatically enabled for the customer. |
add_on |
bool | ✔️ | Whether this is an add-on plan rather than a base subscription. |
status |
models.CreateEntityStatus | ✔️ | Current status of the subscription. |
past_due |
bool | ✔️ | Whether the subscription has overdue payments. |
canceled_at |
Nullable[float] | ✔️ | Timestamp when the subscription was canceled, or null if not canceled. |
expires_at |
Nullable[float] | ✔️ | Timestamp when the subscription will expire, or null if no expiry set. |
trial_ends_at |
Nullable[float] | ✔️ | Timestamp when the trial period ends, or null if not on trial. |
started_at |
float | ✔️ | Timestamp when the subscription started. |
current_period_start |
Nullable[float] | ✔️ | Start timestamp of the current billing period. |
current_period_end |
Nullable[float] | ✔️ | End timestamp of the current billing period. |
quantity |
float | ✔️ | Number of units of this subscription (for per-seat plans). |