Subscription

Get subscription

Get the subscription

get/api/v1/subscription

Response

The request has succeeded.

currentPeriodEndstring date-time required

RFC3339 formatted date-time string in UTC.

currentPeriodStartstring date-time required

RFC3339 formatted date-time string in UTC.

hasStripeSubscriptionboolean

status'trialing' | 'active' required

The status of the subscription.

trialing: The subscription is in a trial period
active: The customer has an active free or paid subscription

trialEligibleboolean

trialEndstring date-time

RFC3339 formatted date-time string in UTC.

Example response

{
  "currentPeriodEnd": "2023-01-01T01:01:01.001Z",
  "currentPeriodStart": "2023-01-01T01:01:01.001Z",
  "items": [
    {
      "entitlement": {
        "activeFrom": "2023-01-01T01:01:01.001Z",
        "activeTo": "2023-01-01T01:01:01.001Z",
        "annotations": {
          "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
        },
        "createdAt": "2024-01-01T01:01:01.001Z",
        "currentUsagePeriod": {
          "from": "2023-01-01T01:01:01.001Z",
          "to": "2023-02-01T01:01:01.001Z"
        },
        "deletedAt": "2024-01-01T01:01:01.001Z",
        "featureId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
        "featureKey": "example-feature-key",
        "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
        "lastReset": "2023-01-01T01:01:01.001Z",
        "measureUsageFrom": "2023-01-01T01:01:01.001Z",
        "metadata": {
          "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
        },
        "subjectKey": "customer-1",
        "updatedAt": "2024-01-01T01:01:01.001Z",
        "usagePeriod": {
          "anchor": "2023-01-01T01:01:01.001Z",
          "interval": "DAY",
          "intervalISO": "P1D"
        }
      },
      "feature": {
        "advancedMeterGroupByFilters": {
          "model": {
            "$in": [
              "gpt-4",
              "gpt-4o"
            ]
          },
          "type": {
            "$eq": "input"
          }
        },
        "archivedAt": "2023-01-01T01:01:01.001Z",
        "createdAt": "2024-01-01T01:01:01.001Z",
        "deletedAt": "2024-01-01T01:01:01.001Z",
        "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
        "metadata": {
          "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
        },
        "meterGroupByFilters": {
          "model": "gpt-4",
          "type": "input"
        },
        "meterSlug": "tokens_total",
        "updatedAt": "2024-01-01T01:01:01.001Z"
      },
      "value": {
        "balance": 100,
        "config": "{ key: \"value\" }",
        "hasAccess": true,
        "totalAvailableGrantAmount": 100,
        "usage": 50
      }
    }
  ],
  "plan": {
    "id": "01G65Z755AFWAKHE12NY0CQ9FH"
  },
  "trialEnd": "2023-01-01T01:01:01.001Z"
}

Changes

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