v4

latestOpenAPI 3.0.22026-08-02109239415.7 KB

manage

Retrieve data relevant to creating an API subscription.

get/manage/api/subscription

Query parameters

organization_idstring required

Workspace to load the subscription for. The caller must be OWNER, ADMIN, or MEMBER of the org. The response shape branches on the org's type (PRIVATE / TEAM_API get recharge settings; ENTERPRISE_API does not).

Response

API subscription content

has_accepted_termsboolean required

Whether or not the latest required terms have been accepted.

has_stripe_setupboolean required

Whether or not Stripe is setup for API usage.

metronome_dashboard_urlstring

The URL to display the customer usage dashboard.

metronome_dashboard_dark_mode_urlstring

The URL to display the customer usage dashboard, in dark mode.

stripe_billing_urlstring

The URL for the user to manage the existing Stripe subscription plan.

Example response

{
  "recharge_settings": {
    "is_active": true
  },
  "has_stripe_setup": true,
  "metronome_dashboard_dark_mode_url": "metronome_dashboard_dark_mode_url",
  "stripe_billing_url": "stripe_billing_url",
  "current_balance": {
    "amount": 1050,
    "currency_code": "USD"
  },
  "has_accepted_terms": true,
  "metronome_dashboard_url": "metronome_dashboard_url",
  "metronome_links": {
    "usage_iframe_url": "usage_iframe_url",
    "usage_iframe_dark_mode_url": "usage_iframe_dark_mode_url",
    "credits_iframe_dark_mode_url": "credits_iframe_dark_mode_url",
    "invoices_iframe_dark_mode_url": "invoices_iframe_dark_mode_url",
    "invoices_iframe_url": "invoices_iframe_url",
    "credits_iframe_url": "credits_iframe_url"
  }
}