Skip to main content
GET
/
v1
/
workspaces
/
{workspace_id}
/
subscription
Get workspace subscription
curl --request GET \
  --url https://api.ziplink.click/v1/workspaces/{workspace_id}/subscription
{
  "amount": 12,
  "cancel_at_period_end": false,
  "currency": "usd",
  "expires_at": "2023-11-07T05:31:56Z",
  "features": [
    "custom_qr_codes"
  ],
  "free": false,
  "payment_frequency": "month",
  "pending_plan_id": "ab782971-4d79-47ab-8685-77cf5a34b2bb",
  "plan_id": "ab782971-4d79-47ab-8685-77cf5a34b2bb",
  "plan_name": "Free Plan",
  "quota": {
    "analytics_retention_days": 30,
    "campaigns": 3,
    "domains": 1,
    "link_in_bios": 1,
    "links": 100,
    "members": 5
  },
  "status": "active"
}

Path Parameters

​
workspace_id
string<uuid>
required

ID of the workspace.

Example:

"ab782971-4d79-47ab-8685-77cf5a34b2bb"

Response

OK

​
amount
number
required
Example:

12

​
cancel_at_period_end
boolean
required

Whether the subscription will be canceled by the end of the billing period.

Example:

false

​
currency
string
required
Example:

"usd"

​
expires_at
string<date-time> | null
required

Date when the subscription expires.

​
features
enum<string>[]
required
​
free
boolean
required

Whether the subscription is paid.

Example:

false

​
payment_frequency
enum<string>
required
Available options:
month,
year
Example:

"month"

​
pending_plan_id
string<uuid> | null
required
Example:

"ab782971-4d79-47ab-8685-77cf5a34b2bb"

​
plan_id
string<uuid>
required
Example:

"ab782971-4d79-47ab-8685-77cf5a34b2bb"

​
plan_name
string
required
Example:

"Free Plan"

​
quota
object
required
​
status
enum<string>
required

Status of the subscription

Available options:
incomplete,
incomplete_expired,
trialing,
active,
past_due,
canceled,
unpaid,
paused
Example:

"active"