Skip to main content
GET
Return a single plan by ID

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer<uint64>
required

The ID of the plan to retrieve

network_id
required

The Network's unique integer ID, or subdomain Unique numeric network ID

Response

A plan object

A plan represents a purchasable offering in your Network

id
integer<uint64>
required

The record's integer ID

Example:

"1234"

created_at
string<date-time>
required

The date and time the record was created

Example:

"2026-08-13T00:16:13+00:00"

updated_at
string<date-time>
required

The date and time the record was last modified

Example:

"2026-08-13T00:16:13+00:00"

name
string
required

The plan's name

Canonical URL to the plan's about page

description
string

The plan's description

status
string

The plan's status (visible, hidden, pending, rejected, archived, legacy)

pricing_type
string

The pricing type (free, subscription, one_time, installment, one_time_installment, token_gated, nonpaid)

visible_to_members
boolean

Whether the plan is visible to members

external
boolean

Whether the plan includes Network membership

multiple
boolean

Whether the plan includes multiple spaces