ArcalotlArcalotl
Plans

List plan tiers

Returns the community's plan tiers, each with its nested billing plans.

Serverhttps://api.arcalotl.com
GET
/v1/plans

Authorization

apiKey
AuthorizationBearer <token>

Community-scoped API key. Send it as Authorization: Bearer arclt_live_.... Keys carry scopes; endpoints that need a specific scope answer 403 missing_scope when the key lacks it.

In: header

Response Body

application/json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/plans"
{
  "data": [
    {
      "id": "tier_01JMZX2A9F",
      "name": "Supporter",
      "description": "Priority support and members-only channels.",
      "kind": "subscription",
      "billing_mode": "recurring",
      "features": [
        "Members-only channels",
        "Priority support"
      ],
      "plans": [
        {
          "id": "plan_01JMZX3B2K",
          "amount_cents": 1500,
          "currency": "usd",
          "interval": "month",
          "trial_days": 0
        }
      ]
    }
  ]
}
{
  "type": "https://docs.arcalotl.com/api/errors#not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "The requested resource was not found.",
  "code": "not_found"
}
{
  "type": "https://docs.arcalotl.com/api/errors#not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "The requested resource was not found.",
  "code": "not_found"
}

POSTCancel a subscription at period end

Schedules a period-end cancellation. The member keeps access until the current period ends, then the subscription transitions to cancelled. Idempotent: a subscription already cancelling returns 202 without another provider call. Supply an `Idempotency-Key` header to make retries safe.

GETGet a plan tier

Returns one plan tier by id, with its nested billing plans.