Skip to main content

Subscription

namestringrequired
platform_subscription_idstringrequired
platform_plan_idstringrequired
statusSubscriptionStatusrequired

Possible values: [active, trialing, past_due, paused, canceled, incomplete]

recurringbooleanrequired
trial_ends_atstring | nullnullable

Display date in the configured timezone, M j, Y (not RFC 3339).

Example: Oct 30, 2026
paused_fromstring | nullnullable

Display date in the configured timezone, M j, Y (not RFC 3339).

Example: Oct 30, 2026
ends_atstring | nullnullable

Display date in the configured timezone, M j, Y (not RFC 3339).

Example: Oct 30, 2026
Subscription
{
"name": "string",
"platform_subscription_id": "string",
"platform_plan_id": "string",
"status": "active",
"recurring": true,
"trial_ends_at": "Oct 30, 2026",
"paused_from": "Oct 30, 2026",
"ends_at": "Oct 30, 2026"
}