This commit is contained in:
John Yeo
2026-02-19 13:24:33 +00:00
parent cd524a641f
commit 90287e6308
994 changed files with 50284 additions and 23041 deletions

View File

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