APIList Project Plans

List Project Plans

Retrieve a paginated list of all plans available for a project.

GET/v2/projects/{project_id}/plans

Authorization

Bearer TokenRequired

Path Parameters

project_idstringRequired

The unique identifier of the project.

Query Parameters

limitintegerDefault: 20

Number of items per page.

offsetintegerDefault: 0

Number of items to skip.

Request
curl -X GET "https://api.botsubscription.com/v2/projects/YOUR_PROJECT_ID/plans?limit=20" \
  -H "Authorization: Bearer YOUR_TOKEN"
Successapplication/json
{
  "ok": true,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "GET",
  "path": "/v2/projects/YOUR_PROJECT_ID/plans",
  "code": 200,
  "total": 3,
  "message": "Plans retrieved successfully",
  "data": [
    {
      "plan_name": "Bronze",
      "plan_price": "10",
      "plan_currency": "USD",
      "plan_duration": "1 hour",
      "plan_price_formatted": "$10.00",
      "plan_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "plan_data": {
        "plan_recurring": true,
        "plan_one_time": true
      },
      "plan_targets": [
        {
          "target_name": "Members",
          "platform": "discord",
          "kind": "role",
          "external_id": "123456789012345678",
          "is_enabled": true,
          "target_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
          "parent_target_id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
          "participant_count": 0
        }
      ]
    },
    {
      "plan_name": "Silver",
      "plan_price": "20",
      "plan_currency": "USD",
      "plan_duration": "1 day",
      "plan_price_formatted": "$20.00",
      "plan_id": "dddddddd-dddd-dddd-dddd-dddddddddddd",
      "plan_data": {
        "plan_recurring": false,
        "plan_one_time": true
      },
      "plan_targets": []
    },
    {
      "plan_name": "Gold",
      "plan_price": "100",
      "plan_currency": "USD",
      "plan_duration": "1 month",
      "plan_price_formatted": "$100.00",
      "plan_id": "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee",
      "plan_data": {
        "plan_recurring": false,
        "plan_one_time": true
      },
      "plan_targets": []
    }
  ]
}

Last updated: