Subscriptions

Get organization subscription

get/v3/subscriptions/{organizationName}

Request

  • Base URL: https://api.zephyr-cloud.io
  • URL: https://api.zephyr-cloud.io/v3/subscriptions/{organizationName}
  • Auth: HTTP bearer

Path parameters

organizationNamestring required

Organization name

Example:my-org

Response

Subscription details

idstring uuid required

Unique identifier for the subscription

cycle'MONTHLY' | 'YEARLY' required

Current billing cycle

tier'PERSONAL' | 'TEAM' | 'PRO' | 'ENTERPRISE' required

Current subscription tier

stripeTierPriceIdstring required

Stripe tier price identifier

stripeCustomerIdstring required

Stripe customer identifier

scheduledTier'PERSONAL' | 'TEAM' | 'PRO' | 'ENTERPRISE' | 'null' nullable required

Tier scheduled for next billing cycle (if downgrading)

scheduleReason'PAYMENT_FAILED' | 'MANUAL_DOWNGRADE' | 'null' nullable required

Reason for the scheduled change

stripeTierSubscriptionItemIdstring required

Stripe tier subscription item identifier

stripeTierProductIdstring required

Stripe tier product identifier

stripeSubscriptionIdstring required

Stripe subscription identifier

stripeScheduleIdstring nullable required

Stripe schedule identifier (for scheduled changes)

invitedOrgIdsstring[] required

IDs of organizations invited to share this subscription

cancelledAtstring date-time nullable required

Date when subscription was cancelled (null if active)

nextBillingAtstring date-time required

Next billing date

lastInvoicedAtstring date-time required

Last invoice date

startedAtstring date-time required

Subscription start date

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "cycle": "MONTHLY",
  "tier": "PRO",
  "stripeTierPriceId": "price_tier_pro_monthly",
  "stripeCustomerId": "cus_1234567890",
  "stripeTierSubscriptionItemId": "si_tier_1234567890",
  "stripeTierProductId": "prod_tier_pro",
  "stripeSubscriptionId": "sub_1234567890",
  "invitedOrgIds": [],
  "nextBillingAt": "2025-02-17T00:00:00.000Z",
  "lastInvoicedAt": "2025-01-17T00:00:00.000Z",
  "startedAt": "2024-01-17T00:00:00.000Z",
  "quotas": [
    {
      "metric": "DEPLOYMENTS",
      "limit": 10000,
      "overage": 1000
    }
  ],
  "coupon": {
    "stripeCouponId": "ZEPHYR_DISCOUNT_20",
    "percentOff": 20,
    "amountOff": 500,
    "productIds": [
      "prod_123",
      "prod_456"
    ],
    "forcedSeats": 5
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.