Billing
Get the usage data for a workspace
The ID of the workspace to get usage data for
The usage of the workspace
Not found
Validation Error
GET /billing/{workspace_id}/workspace-usage HTTP/1.1
Host:
Accept: */*
{
"seats": {
"used": 1,
"included": 1,
"enforced": true
},
"guests": {
"used": 1,
"included": 1,
"enforced": true
},
"has_payment_method": true,
"cloud_storage": {
"free": 1,
"paid": 1,
"used": 1
},
"byo_storage": {
"free": 1,
"paid": 1,
"used": 1
},
"vault_storage": {
"free": 1,
"paid": 1,
"used": 1
},
"drives": {
"used": 1,
"included": 1,
"enforced": true
},
"ai_indexed_items": {
"used": 1,
"included": 1,
"enforced": true
},
"cloud_drives": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"usage": 1
}
],
"byo_drives": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"usage": 1
}
],
"vault_drives": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"usage": 1
}
],
"monthly_subscription_status": "text",
"annual_subscription_status": "text",
"credits": 1
}Get the usage data for a drive
The ID of the drive to get usage data for
The usage of the drive
Not found
Validation Error
GET /billing/{drive_id}/drive-usage HTTP/1.1
Host:
Accept: */*
{
"types": [
{
"type": "IMAGE",
"count": 1,
"size": 1
}
],
"usage": 1,
"total_storage": 1,
"total_items": 1
}Get the usage data for a workspace
The ID of the workspace to get usage data for
The usage of the workspace
Not found
Validation Error
GET /billing/{workspace_id}/usage HTTP/1.1
Host:
Accept: */*
{
"billing": {
"start_time": 1,
"end_time": 1,
"total_cloud_paid": 1,
"total_vault_paid": 1,
"total_byo_paid": 1,
"total_cloud_free": 1,
"total_vault_free": 1,
"total_byo_free": 1,
"cloud_overage": 1,
"byo_overage": 1,
"vault_storage_overage": 1
},
"plan": "text",
"plan_name": "text",
"seats_annual": true,
"is_trial": true,
"seats": 1
}Get the invoices for a workspace
The ID of the workspace to get invoices for
Whether to get the upcoming invoice
falseThe invoices of the workspace
Not found
Validation Error
GET /billing/{workspace_id}/invoices HTTP/1.1
Host:
Accept: */*
[
{
"total_amount_due": 1,
"period_start": 1,
"period_end": 1,
"invoice_date": 1,
"paid": true,
"invoice_pdf": "text",
"hosted_invoice_url": "text",
"tax": 1,
"subtotal": 1,
"lines": [
{
"description": "text",
"amount": 1,
"quantity": 1,
"unit_type": "text",
"unit_amount": 1
}
],
"status": "text",
"currency": "text"
}
]Update the payment method for a workspace
The ID of the workspace to update the payment method for
The ID of the payment method to update to
Whether this is the first added payment method (not updated later on)
falseSuccessful Response
Not found
Validation Error
PUT /billing/{workspace_id}/payment-method HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 45
{
"payment_method_id": "text",
"is_first": false
}No content
Update the billing address for a workspace
The ID of the workspace to update the billing address for
The ID of the payment method to update to
Successful Response
Not found
Validation Error
PUT /billing/{workspace_id}/billing-address HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 178
{
"address": {
"name": "text",
"phone": "text",
"address": {
"line1": "text",
"line2": "text",
"city": "text",
"state": "text",
"postal_code": "text",
"country": "text"
}
},
"payment_method_id": "text"
}No content
Get the payment methods for a workspace
The ID of the workspace to get the payment methods for
Successful Response
Not found
Validation Error
GET /billing/{workspace_id}/payment-methods HTTP/1.1
Host:
Accept: */*
[
{
"id": "text",
"brand": "text",
"type": "text",
"last4": "text",
"exp_month": 1,
"exp_year": 1,
"funding": "text",
"country": "text",
"address": "text",
"city": "text",
"state": "text",
"zip": "text",
"name": "text"
}
]Update the plan for a workspace
The ID of the workspace to update the plan for
The ID of the price plan to update to
The number of seats to update to
Successful Response
Not found
Validation Error
PUT /billing/{workspace_id}/plan?price_id=text HTTP/1.1
Host:
Accept: */*
No content
Get the current invoice for a workspace
The ID of the workspace to get the current invoice for
Successful Response
Not found
Validation Error
GET /billing/{workspace_id}/current-invoice HTTP/1.1
Host:
Accept: */*
{
"total_amount_due": 1,
"period_start": 1,
"period_end": 1,
"invoice_date": 1,
"paid": true,
"invoice_pdf": "text",
"hosted_invoice_url": "text",
"tax": 1,
"subtotal": 1,
"lines": [
{
"description": "text",
"amount": 1,
"quantity": 1,
"unit_type": "text",
"unit_amount": 1
}
],
"status": "text",
"currency": "text"
}Get the upcoming monthly invoice for a workspace
The ID of the workspace to get the upcoming monthly invoice for
Successful Response
Not found
Validation Error
GET /billing/{workspace_id}/upcoming-monthly-invoice HTTP/1.1
Host:
Accept: */*
{
"total_amount_due": 1,
"period_start": 1,
"period_end": 1,
"invoice_date": 1,
"paid": true,
"invoice_pdf": "text",
"hosted_invoice_url": "text",
"tax": 1,
"subtotal": 1,
"lines": [
{
"description": "text",
"amount": 1,
"quantity": 1,
"unit_type": "text",
"unit_amount": 1
}
],
"status": "text",
"currency": "text"
}Get the annual subscriptions for a workspace
The ID of the workspace to get the annual subscriptions for
Successful Response
Not found
Validation Error
GET /billing/{workspace_id}/annual-subscriptions HTTP/1.1
Host:
Accept: */*
No content
Update the billing email for a workspace
The ID of the workspace to update the billing email for
The email to update the billing email to
Successful Response
Not found
Validation Error
PUT /billing/{workspace_id}/billing-email HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"email": "text"
}No content