Orders

List orders

GET/v1/billing/orders

curl --request GET \
  --url https://api.serverside.com/v1/billing/orders \
  --header 'X-API-KEY: <api-key>'

{
  "success": true,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organization": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2026-01-15T09:30:00Z",
        "name": "<string>",
        "billedByEntity": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "currency": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "conversionRate": 123
        },
        "currencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "vatNumber": "<string>",
        "creditBalance": {
          "value": 123
        },
        "billingAddress": {
          "address1": "<string>",
          "address2": "<string>",
          "city": "<string>",
          "region": "<string>",
          "postalCode": "<string>",
          "countryCode": "<string>"
        },
        "billingContact": {
          "emailAddress": "ops@example.com",
          "phoneNumber": "<string>"
        },
        "paymentMethods": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "provider": "STRIPE",
            "kind": "CARD",
            "paymentMethodId": "<string>",
            "priority": 123,
            "creditCardMeta": {
              "last4": "<string>",
              "brand": "<string>",
              "expMonth": 123,
              "expYear": 123
            },
            "walletMeta": {
              "brand": "<string>",
              "identifier": "<string>"
            }
          }
        ],
        "stripeCustomerId": "<string>",
        "members": [
          {
            "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "joinedAt": "2026-01-15T09:30:00Z",
            "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "organization": {},
            "user": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "userName": "<string>",
              "normalizedUserName": "<string>",
              "email": "<string>",
              "normalizedEmail": "<string>",
              "emailConfirmed": true,
              "passwordHash": "<string>",
              "securityStamp": "<string>",
              "concurrencyStamp": "<string>",
              "phoneNumber": "<string>",
              "phoneNumberConfirmed": true,
              "lockoutEnd": "2026-01-15T09:30:00Z",
              "lockoutEnabled": true,
              "accessFailedCount": 123,
              "createdAt": "2026-01-15T09:30:00Z",
              "firstName": "<string>",
              "lastName": "<string>",
              "lastLoginIP": "<string>",
              "lastLoginDate": "2026-01-15T09:30:00Z",
              "passwordLastChangedAt": "2026-01-15T09:30:00Z",
              "twoFactorEnabledAt": "2026-01-15T09:30:00Z",
              "orgMemberships": [
                {}
              ],
              "userRoles": [
                {
                  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "user": {},
                  "role": {}
                }
              ],
              "roleInfo": {
                "roles": [
                  "<string>"
                ],
                "isAdmin": true,
                "isSuperAdmin": true
              },
              "twoFactorEnabled": true
            },
            "role": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "name": "<string>",
              "permissions": [
                "<string>"
              ],
              "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "organization": {},
              "isExclusive": true
            }
          }
        ],
        "invites": [
          {
            "invitationTime": "2026-01-15T09:30:00Z",
            "invitedEmail": "<string>",
            "invitedRoleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "inviteCode": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "customRoles": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "permissions": [
              "<string>"
            ],
            "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "organization": {},
            "isExclusive": true
          }
        ],
        "ownershipTransfer": {
          "code": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "expirationDate": "2026-01-15T09:30:00Z",
          "transferToEmail": "<string>"
        },
        "roleHierarchy": {
          "roleIds": [
            "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          ]
        }
      },
      "status": "UNPAID",
      "promoCode": "<string>",
      "datePlaced": "2026-01-15T09:30:00Z",
      "cycle": {
        "value": "HOURLY",
        "isUsageBased": true,
        "isReservationBased": true,
        "months": 123
      },
      "idempotencyKey": "<string>",
      "items": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "title": "<string>",
          "status": "PENDING",
          "type": "BAREMETAL",
          "completedAt": "2026-01-15T09:30:00Z",
          "offeringId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "provisionedId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "baseRate": {
            "value": 123
          },
          "taxRate": 123,
          "discountRate": 123,
          "details": {}
        }
      ],
      "subtotal": {
        "value": 123
      },
      "totalDiscount": {
        "value": 123
      },
      "totalTax": {
        "value": 123
      },
      "total": {
        "value": 123
      },
      "amountDue": {
        "value": 123
      }
    }
  ],
  "pagination": {
    "totalRecords": 123,
    "currentPage": 123,
    "pageSize": 123,
    "totalPages": 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.read

Query parameters

searchstring
filterobject
pageinteger<int32>
Limits:1 <= x <= 2147483
pageSizeinteger<int32>
Limits:1 <= x <= 1000
sortColumnstring
ascendingboolean

Response

200 · application/json

OK

successboolean
Allowed values:true
dataobject[] | null
paginationobject