AXaxilioai
billing

Get current plan

Changed on

Returns the caller organization's active subscription plan. Only an active subscription is returned; if the org has none, this responds 404. (The status field is therefore always 'active' here.)

get/billing/subscription

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-Axilio-Api-Key

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

balance_displaystring required

Formatted balance string (e.g., '$12.50').

balance_microdollarsinteger required

Current account balance in microdollars.

billing_cycle'monthly' | 'yearly' required

Billing frequency for this subscription.

cancel_at_period_endboolean required

Whether the subscription cancels at the end of the period.

canceled_atstring date-time

Timestamp when the subscription was canceled.

current_period_end_atstring date-time required

End of the current billing period.

current_period_start_atstring date-time required

Start of the current billing period.

idstring uuid required

Subscription identifier.

included_balance_displaystring required

Formatted included balance (e.g., '$10.00').

included_balance_microdollarsinteger required

Balance granted each billing period in microdollars.

max_concurrent_runsinteger required

Maximum simultaneous runs allowed on this plan.

monthly_price_microdollarsinteger required

Monthly plan price in microdollars (1_000_000 = $1.00).

pending_downgrade_atstring date-time

When the pending downgrade takes effect.

pending_downgrade_plan_idstring

Plan ID of a scheduled future downgrade.

plan_idstring uuid required

Billing plan's identifier.

plan_namestring required

Customer-facing plan name (Hobby, Pro, Scale, Enterprise).

price_per_second_microdollarsinteger required

Per-second compute charge in microdollars.

status'active' | 'canceled' | 'past_due' | 'trialing' | 'incomplete' | 'incomplete_expired' | 'unpaid' required

Current lifecycle state of the subscription.

trial_end_atstring date-time

Timestamp when the free trial ends.

yearly_price_microdollarsinteger required

Annual plan price in microdollars.

Example response

{
  "$schema": "/api/v1/SubscriptionResponse.json"
}

Changes

  • 49b1da5a7974Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • e2261ff54e62Revision changes
    • info

      the endpoint scheme security bearerAuth was removed from the API