Orders

Create order

POST/v1/billing/orders

curl --request POST \
  --url https://api.serverside.com/v1/billing/orders \
  --header 'X-API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "services": [
    {
      "offeringId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "cycle": "HOURLY",
  "promoCode": "<string>"
}
'

{
  "success": true,
  "message": "<string>",
  "exception": "<string>",
  "code": "<string>",
  "errors": {},
  "traceId": "<string>",
  "data": {
    "order": {
      "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
      }
    },
    "invoiceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subscriptions": [
      {
        "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": [
                  {}
                ],
                "roleInfo": {
                  "roles": [],
                  "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"
            ]
          }
        },
        "lastRenewal": "2026-01-15T09:30:00Z",
        "nextRenewal": "2026-01-15T09:30:00Z",
        "createdAt": "2026-01-15T09:30:00Z",
        "terminatedAt": "2026-01-15T09:30:00Z",
        "cycle": {
          "value": "HOURLY",
          "isUsageBased": true,
          "isReservationBased": true,
          "months": 123
        },
        "items": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "subscriptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "orderItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "provisionedId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "BAREMETAL",
            "details": {},
            "title": "<string>",
            "subtotal": {
              "value": 123
            },
            "discountRate": 123,
            "terminatedAt": "2026-01-15T09:30:00Z",
            "isTerminated": true
          }
        ],
        "status": "ACTIVE",
        "activeItems": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "subscriptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "orderItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "provisionedId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "BAREMETAL",
            "details": {},
            "title": "<string>",
            "subtotal": {
              "value": 123
            },
            "discountRate": 123,
            "terminatedAt": "2026-01-15T09:30:00Z",
            "isTerminated": true
          }
        ]
      }
    ],
    "provisionedItems": [
      {
        "orderItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "provisionedId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "success": true,
        "errorMessage": "<string>"
      }
    ],
    "replayed": true
  },
  "pagination": {
    "totalRecords": 123,
    "currentPage": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

Autorisatie

X-API-KEYstringheaderverplicht
Organization API key. Create one in the cloud console at https://cloud.serverside.com; the key is shown once, when it is created.

Headers

Idempotency-Keystring
Grenzen:length <= 200

Body

application/json

servicesobject[]verplicht
cycleenum<string>
Toegestane waarden:HOURLYMONTHLYQUARTERLYSEMI_ANNUALLYANNUALLY
promoCodestring

Antwoord

200 · application/json

OK

successboolean
messagestring | null
exceptionstring | null
codestring | null
errorsobject | null
traceIdstring | null
dataobject
paginationobject