Cudo Compute logoDocumentation

Billing

These are the endpoints for Billing. More information coming soon.

GET/v1/billing-accounts

List billing accounts

Description for this endpoint is coming soon.

Path attributes

  • Name
    pageToken
    Type
    string
    Description
  • Name
    pageSize
    Type
    integer
    Description

Request

GET
/v1/billing-accounts
curl 'https://rest.compute.cudo.org/v1/billing-accounts' \
-H 'Accept: application/json'

Response

{
    "billingAccounts": "array",
    "pageSize": "integer",
    "pageToken": "string"
}
POST/v1/billing-accounts

Create a billing account

Description for this endpoint is coming soon.

Request

POST
/v1/billing-accounts
curl 'https://rest.compute.cudo.org/v1/billing-accounts' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
    "displayName": "string",
    "email": "string",
    "invoiceName": "string"
}'

Response

{
    "createBy": "string",
    "createTime": "string",
    "demandEnabled": "boolean",
    "displayName": "string",
    "id": "string",
    "stripeRef": "string",
    "supplyEnabled": "boolean"
}
GET/v1/billing-accounts/spend

Get outstanding spend

Description for this endpoint is coming soon.

Path attributes

  • Name
    pageNumber
    Type
    integer
    Description
  • Name
    pageSize
    Type
    integer
    Description

Request

GET
/v1/billing-accounts/spend
curl 'https://rest.compute.cudo.org/v1/billing-accounts/spend' \
-H 'Accept: application/json'

Response

{
    "outstandingBillingAccountSpend": "array"
}
PATCH/v1/billing-accounts/{billingAccount.id}

Update billing account

Description for this endpoint is coming soon.

Body attributes

  • Name
    createBy
    Type
    string
    Description
  • Name
    createTime
    Type
    string
    Description
  • Name
    demandEnabled
    Type
    boolean
    Description
  • Name
    displayName
    Type
    string
    Description
  • Name
    stripeRef
    Type
    string
    Description
  • Name
    supplyEnabled
    Type
    boolean
    Description

Path attributes

  • Name
    billingAccount.id
    Type
    string
    Description
  • Name
    updateMask
    Type
    string
    Description

Request

PATCH
/v1/billing-accounts/{billingAccount.id}
curl 'https://rest.compute.cudo.org/v1/billing-accounts/{billingAccount.id}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
    "createBy": "string",
    "createTime": "string",
    "demandEnabled": "boolean",
    "displayName": "string",
    "stripeRef": "string",
    "supplyEnabled": "boolean"
}'

Response

{
    "createBy": "string",
    "createTime": "string",
    "demandEnabled": "boolean",
    "displayName": "string",
    "id": "string",
    "stripeRef": "string",
    "supplyEnabled": "boolean"
}
GET/v1/billing-accounts/{billingAccountId}/spend/{spendId}/details

Get spend details

Description for this endpoint is coming soon.

Path attributes

  • Name
    billingAccountId
    Type
    string
    Description
  • Name
    spendId
    Type
    string
    Description

Request

GET
/v1/billing-accounts/{billingAccountId}/spend/{spendId}/details
curl 'https://rest.compute.cudo.org/v1/billing-accounts/{billingAccountId}/spend/{spendId}/details' \
-H 'Accept: application/json'

Response

{
    "billingAccountName": "string",
    "projects": "array",
    "spend": "object"
}
GET/v1/billing-accounts/{billingAccountId}/spend/{spendId}/payment-intent

Get payment intent for spend

Description for this endpoint is coming soon.

Path attributes

  • Name
    billingAccountId
    Type
    string
    Description
  • Name
    spendId
    Type
    string
    Description

Request

GET
/v1/billing-accounts/{billingAccountId}/spend/{spendId}/payment-intent
curl 'https://rest.compute.cudo.org/v1/billing-accounts/{billingAccountId}/spend/{spendId}/payment-intent' \
-H 'Accept: application/json'

Response

{
    "amount": "string",
    "clientSecret": "string",
    "currency": "string",
    "id": "string",
    "lastPaymentErrorCode": "string",
    "paymentMethod": "string",
    "status": "string"
}
GET/v1/billing-accounts/{billingAccountId}/spend/{spendId}/refresh

Refresh payment status for spend

Description for this endpoint is coming soon.

Path attributes

  • Name
    billingAccountId
    Type
    string
    Description
  • Name
    spendId
    Type
    string
    Description

Request

GET
/v1/billing-accounts/{billingAccountId}/spend/{spendId}/refresh
curl 'https://rest.compute.cudo.org/v1/billing-accounts/{billingAccountId}/spend/{spendId}/refresh' \
-H 'Accept: application/json'

Response

{
    "billingAccountId": "string",
    "endTime": "string",
    "finalised": "boolean",
    "paymentIntentId": "string",
    "paymentSuccess": "boolean",
    "spend": "object",
    "startTime": "string",
    "uid": "string"
}
GET/v1/billing-accounts/{id}

Get a billing account

Description for this endpoint is coming soon.

Path attributes

  • Name
    id
    Type
    string
    Description

Request

GET
/v1/billing-accounts/{id}
curl 'https://rest.compute.cudo.org/v1/billing-accounts/{id}' \
-H 'Accept: application/json'

Response

{
    "createBy": "string",
    "createTime": "string",
    "demandEnabled": "boolean",
    "displayName": "string",
    "id": "string",
    "stripeRef": "string",
    "supplyEnabled": "boolean"
}
DELETE/v1/billing-accounts/{id}

Delete billing account

Description for this endpoint is coming soon.

Path attributes

  • Name
    id
    Type
    string
    Description

Request

DELETE
/v1/billing-accounts/{id}
curl 'https://rest.compute.cudo.org/v1/billing-accounts/{id}' \
-H 'Accept: application/json'
GET/v1/billing-accounts/{id}/details

Get billing account details

Description for this endpoint is coming soon.

Path attributes

  • Name
    id
    Type
    string
    Description

Request

GET
/v1/billing-accounts/{id}/details
curl 'https://rest.compute.cudo.org/v1/billing-accounts/{id}/details' \
-H 'Accept: application/json'

Response

{
    "billingAccount": "object",
    "stripeCustomer": "object"
}
GET/v1/billing-accounts/{id}/payment-methods

Get payment methods

Description for this endpoint is coming soon.

Path attributes

  • Name
    id
    Type
    string
    Description

Request

GET
/v1/billing-accounts/{id}/payment-methods
curl 'https://rest.compute.cudo.org/v1/billing-accounts/{id}/payment-methods' \
-H 'Accept: application/json'

Response

{
    "paymentMethods": "array"
}
DELETE/v1/billing-accounts/{id}/payment-methods/{paymentMethodId}

Remove payment method

Description for this endpoint is coming soon.

Path attributes

  • Name
    id
    Type
    string
    Description
  • Name
    paymentMethodId
    Type
    string
    Description

Request

DELETE
/v1/billing-accounts/{id}/payment-methods/{paymentMethodId}
curl 'https://rest.compute.cudo.org/v1/billing-accounts/{id}/payment-methods/{paymentMethodId}' \
-H 'Accept: application/json'

Response

{
    "id": "string",
    "paymentMethodId": "string"
}
POST/v1/billing-accounts/{id}/payment-methods/{paymentMethodId}/set-default

Set default payment method

Description for this endpoint is coming soon.

Path attributes

  • Name
    id
    Type
    string
    Description
  • Name
    paymentMethodId
    Type
    string
    Description

Request

POST
/v1/billing-accounts/{id}/payment-methods/{paymentMethodId}/set-default
curl 'https://rest.compute.cudo.org/v1/billing-accounts/{id}/payment-methods/{paymentMethodId}/set-default' \
-H 'Accept: application/json'

Response

{
    "id": "string",
    "paymentMethodId": "string"
}
GET/v1/billing-accounts/{id}/setup-intent

Get setup intent

Description for this endpoint is coming soon.

Path attributes

  • Name
    id
    Type
    string
    Description

Request

GET
/v1/billing-accounts/{id}/setup-intent
curl 'https://rest.compute.cudo.org/v1/billing-accounts/{id}/setup-intent' \
-H 'Accept: application/json'

Response

{
    "clientSecret": "string",
    "id": "string"
}
GET/v1/billing-accounts/{id}/spend

Spend history

Description for this endpoint is coming soon.

Path attributes

  • Name
    id
    Type
    string
    Description

Request

GET
/v1/billing-accounts/{id}/spend
curl 'https://rest.compute.cudo.org/v1/billing-accounts/{id}/spend' \
-H 'Accept: application/json'

Response

{
    "billingAccountSpendHistory": "array"
}
GET/v1/billing-accounts/{id}/spend/current

Outstanding spend

Description for this endpoint is coming soon.

Path attributes

  • Name
    id
    Type
    string
    Description

Request

GET
/v1/billing-accounts/{id}/spend/current
curl 'https://rest.compute.cudo.org/v1/billing-accounts/{id}/spend/current' \
-H 'Accept: application/json'

Response

{
    "billingAccountId": "string",
    "endTime": "string",
    "finalised": "boolean",
    "paymentIntentId": "string",
    "paymentSuccess": "boolean",
    "spend": "object",
    "startTime": "string",
    "uid": "string"
}