Billing

Server

Download schema

获取billing

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/billing

获取billing › Responses

请求成功

BillingSummaryResponse

enabled

boolean · required

BillingPlanDefinition[] · required

object · required

canManageBilling

boolean · required

GET/v1/billing

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/billing

Example Responses

{
  "enabled": true,
  "plans": [
    {
      "key": "free",
      "name": "name",
      "description": "description",
      "monthlyPricePerSeat": 0,
      "annualPricePerSeat": 0,
      "annualTotalPerSeat": 0,
      "currency": "usd",
      "limits": {
        "seats": 0,
        "monthlyAudioMinutesPerSeat": 0,
        "activeProjects": 0,
        "referenceDocuments": 0
      },
      "features": [
        "string"
      ]
    }
  ],
  "subscription": {
    "planKey": "free",
    "status": "free",
    "interval": "monthly",
    "seatQuantity": 0,
    "currentPeriodEnd": "currentPeriodEnd",
    "cancelAtPeriodEnd": true,
    "hasPaidAccess": true
  },
  "usage": {
    "periodStart": "periodStart",
    "audioSeconds": 0,
    "audioLimitSeconds": 0,
    "activeProjects": 0,
    "projectLimit": 0,
    "members": 0,
    "pendingInvitations": 0,
    "seatLimit": 0,
    "referenceDocuments": 0,
    "referenceDocumentLimit": 0
  },
  "canManageBilling": true
}

json

application/json

创建或执行billing · checkout

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/billing/checkout

创建或执行billing · checkout › Request Body

GenericRequest

创建或执行billing · checkout › Responses

请求成功

BillingRedirectResponse

url

string · required

创建或执行billing · portal

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/billing/portal

创建或执行billing · portal › Request Body

GenericRequest

创建或执行billing · portal › Responses

请求成功

BillingRedirectResponse

url

string · required

创建或执行billing · webhook

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/billing/webhook

创建或执行billing · webhook › Request Body

GenericRequest

创建或执行billing · webhook › Responses

请求成功

GenericResponse

Voice

CapWorks HTTP API

Billing

Server

Download schema

获取billing

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/billing

获取billing › Responses

请求成功

BillingSummaryResponse

enabled

boolean · required

BillingPlanDefinition[] · required

object · required

canManageBilling

boolean · required

GET/v1/billing

curl https://capworks-api-docs.pages.dev/proxy/capworks/v1/billing

Example Responses

{
  "enabled": true,
  "plans": [
    {
      "key": "free",
      "name": "name",
      "description": "description",
      "monthlyPricePerSeat": 0,
      "annualPricePerSeat": 0,
      "annualTotalPerSeat": 0,
      "currency": "usd",
      "limits": {
        "seats": 0,
        "monthlyAudioMinutesPerSeat": 0,
        "activeProjects": 0,
        "referenceDocuments": 0
      },
      "features": [
        "string"
      ]
    }
  ],
  "subscription": {
    "planKey": "free",
    "status": "free",
    "interval": "monthly",
    "seatQuantity": 0,
    "currentPeriodEnd": "currentPeriodEnd",
    "cancelAtPeriodEnd": true,
    "hasPaidAccess": true
  },
  "usage": {
    "periodStart": "periodStart",
    "audioSeconds": 0,
    "audioLimitSeconds": 0,
    "activeProjects": 0,
    "projectLimit": 0,
    "members": 0,
    "pendingInvitations": 0,
    "seatLimit": 0,
    "referenceDocuments": 0,
    "referenceDocumentLimit": 0
  },
  "canManageBilling": true
}

json

application/json

创建或执行billing · checkout

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/billing/checkout

创建或执行billing · checkout › Request Body

GenericRequest

创建或执行billing · checkout › Responses

请求成功

BillingRedirectResponse

url

string · required

创建或执行billing · portal

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/billing/portal

创建或执行billing · portal › Request Body

GenericRequest

创建或执行billing · portal › Responses

请求成功

BillingRedirectResponse

url

string · required

创建或执行billing · webhook

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/v1/billing/webhook

创建或执行billing · webhook › Request Body

GenericRequest

创建或执行billing · webhook › Responses

请求成功

GenericResponse

Voice