Credit

Purchase credit

POST/v1/billing/credit/purchase

curl --request POST \
  --url https://api.serverside.com/v1/billing/credit/purchase \
  --header 'X-API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123
}
'

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2026-01-15T09:30:00Z",
    "dueDate": "2026-01-15T09:30:00Z",
    "status": "UNPAID",
    "type": "STANDARD",
    "currency": "<string>",
    "invoiceNumber": 123,
    "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "billedFrom": {
      "companyName": "<string>",
      "address1": "<string>",
      "address2": "<string>",
      "city": "<string>",
      "region": "<string>",
      "postalCode": "<string>",
      "countryCode": "<string>",
      "vatNumber": "<string>",
      "emailAddress": "<string>",
      "phoneNumber": "<string>"
    },
    "billedTo": {
      "organizationName": "<string>",
      "address1": "<string>",
      "address2": "<string>",
      "city": "<string>",
      "region": "<string>",
      "postalCode": "<string>",
      "countryCode": "<string>",
      "vatNumber": "<string>",
      "emailAddress": "<string>",
      "phoneNumber": "<string>"
    },
    "taxBreakdown": [
      {
        "name": "<string>",
        "rate": 123,
        "amount": 123,
        "taxId": "<string>"
      }
    ],
    "items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "subscriptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "startTime": "2026-01-15T09:30:00Z",
        "endTime": "2026-01-15T09:30:00Z",
        "subtotal": 123,
        "discount": 123,
        "taxTreatment": "STANDARD",
        "taxRate": 123,
        "taxAmount": 123,
        "total": 123
      }
    ],
    "transactions": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "transactionReference": "<string>",
        "amount": 123,
        "currency": "<string>",
        "createdAt": "2026-01-15T09:30:00Z",
        "paymentProvider": "<string>",
        "status": "<string>"
      }
    ],
    "subtotal": 123,
    "discount": 123,
    "taxes": 123,
    "total": 123,
    "amountDue": 123
  }
}

Authorizations

X-API-KEYstringheaderrequired
Organization API key, created in the cloud console at https://cloud.serverside.com and shown once. It authenticates as the organization.

Required permission: organization.billing.pay

Body

application/json

amountinteger<int64>

Response

200 · application/json

OK

successboolean
Allowed values:true
dataobject