Subscription

The subscription details of an org.

  {
      "collectionMethod": "CHARGE_AUTOMATICALLY",
      "currency": "USD",
      "expiresAt": "2023-10-19T15:19:42.000Z",
      "plan": "ENTERPRISE",
      "provider": "STRIPE",
      "status": "TRIALING"
  }

Properties

collectionMethod ^{CollectionMethod optional}

The subscription payment collection method for the org.

Default is CHARGE_AUTOMATICALLY.

currency ^string

The currency in which the subscription was paid. This is the three-letter ISO currency code (opens in a new tab) of a supported currency, in uppercase.

Supported options are EUR, GBP, NGN, USD.

expiresAt ^{Date optional}

The expiration date for the org's subscription plan.

plan ^Plan

The subscription plan of the org.

Default is Free.

provider ^string

The subscription provider.

The only supported option is STRIPE.

status ^{PlanStatus optional}

The current status of the org's subscription plan.