API ReferenceBilling API

Billing API

Billing management endpoints

Auto-generated from OpenAPI spec on 2025-10-02


GET /billing/webhook

GET webhook

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/billing/webhook \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

POST /billing/webhook

POST webhook

Request Body

{}

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X POST https://api.syaala.com/billing/webhook \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

POST /billing/upgrade

POST upgrade

🔒 Authentication Required: Bearer token

Request Body

{}

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X POST https://api.syaala.com/billing/upgrade \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

GET /billing/invoices

GET invoices

🔒 Authentication Required: Bearer token

Parameters

NameTypeRequiredDescription
orgIdqueryYesOrganization ID

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/billing/invoices \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

POST /billing/portal

POST portal

🔒 Authentication Required: Bearer token

Request Body

{}

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X POST https://api.syaala.com/billing/portal \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

GET /billing/invoices/{id}/download

GET download

🔒 Authentication Required: Bearer token

Parameters

NameTypeRequiredDescription
idpathYesid identifier
orgIdqueryYesOrganization ID

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/billing/invoices/abc123/download \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"