Skip to main content
GET
Get Subscription

Autorizaciones

Authorization
string
header
requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Respuesta

Successful Response

name
string
requerido

Name of the subscription plan

period_start
string<date-time>
requerido

Start date of the current billing period

period_end
string<date-time>
requerido

End date of the current billing period

included_minutes
integer
requerido

Number of included minutes in the plan

active_since
string<date-time>
requerido

Date when the subscription became active

price
number
requerido

Price of the subscription plan

currency
string
requerido

Currency of the subscription plan

period
enum<string>
requerido

Billing period of the subscription plan

Opciones disponibles:
month,
year,
day,
week
overage_price_per_minute
number | null
requerido

Price per minute for usage beyond the included minutes, null if metered usage is disabled.

usage_based_billing_enabled
boolean
requerido

Indicates if metered usage is enabled for the company

minutes_count
integer
requerido

Total number of minutes used in the current billing period

rollover_minutes_count
integer
requerido

Number of rollover minutes available in the current billing period

next_payment_date
string<date-time>
requerido

Date of the next payment. If usage-based billing is enabled, this is the usage item's period end (monthly). Otherwise, it's the base plan period end (subscription renewal date).

knowledge_storage_used_bytes
integer
requerido

Total bytes used by knowledge items

knowledge_items_count
integer
requerido

Total number of knowledge items

included_workflows
integer
requerido

Number of workflows included in the plan

max_concurrent_calls
integer | null

Maximum simultaneous calls allowed by the plan (null if unlimited)

next_phase
SubscriptionPhaseSchema · object | null

Information about the next scheduled subscription phase

knowledge_storage_limit_bytes
integer | null

Maximum storage bytes allowed by the plan (null if no limit configured)

copilot_usage_percent
number
predeterminado:0

Percentage of weekly copilot budget used (0-100)

workflows_count
integer | null

Current number of enabled workflows in the project (only enabled workflows count toward the plan limit). Omitted when the workflow service is unreachable; 0 when the company has no workflow project yet.