Arkloop Developers

Subscriptions & Plans

Plans

List Plans

GET /v1/plans

Response

[
  {
    "id": "...",
    "name": "starter",
    "display_name": "Starter",
    "created_at": "2024-01-01T00:00:00Z",
    "entitlements": [
      {
        "id": "...",
        "key": "credits.monthly_grant",
        "value": "1000",
        "value_type": "integer"
      }
    ]
  }
]

Get Plan

GET /v1/plans/{id}

Create Plan

POST /v1/plans

Requires platform_admin permission.

Request Body

FieldTypeRequiredDescription
namestringYesInternal name (unique)
display_namestringYesDisplay name
entitlementsarrayNoInitial entitlements list

Entitlement Object

FieldTypeDescription
keystringEntitlement key
valuestringEntitlement value
value_typestringinteger/boolean/string

Subscriptions

Create Subscription

POST /v1/subscriptions

Requires platform_admin permission.

Request Body

FieldTypeRequired
org_idstringYes
plan_idstringYes
current_period_startstringYes
current_period_endstringYes

Response

{
  "id": "...",
  "org_id": "...",
  "plan_id": "...",
  "status": "active",
  "current_period_start": "2024-01-01T00:00:00Z",
  "current_period_end": "2024-02-01T00:00:00Z",
  "cancelled_at": null,
  "created_at": "2024-01-01T00:00:00Z"
}

List Subscriptions

GET /v1/subscriptions

Get Subscription

GET /v1/subscriptions/{id}

Cancel Subscription

DELETE /v1/subscriptions/{id}

On this page