Create a billing account

Creates a new billing account.

POST /v1/billing-accounts

Create a billing account

cURL

curl --request POST \
  --url https://rest.compute.cudo.org/v1/billing-accounts \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "email": "<string>",
  "billingAddress": {
    "city": "<string>",
    "country": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "name": "<string>",
    "phone": "<string>",
    "postalCode": "<string>",
    "state": "<string>"
  },
  "invoiceName": "<string>",
  "referral": "<string>",
  "taxId": {
    "type": "<string>",
    "value": "<string>"
  }
}
'

200

{
  "billingAddress": {
    "city": "<string>",
    "country": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "name": "<string>",
    "phone": "<string>",
    "postalCode": "<string>",
    "state": "<string>"
  },
  "billingThreshold": {
    "value": "<string>"
  },
  "createBy": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "creditBalance": {
    "value": "<string>"
  },
  "creditBalanceRecharge": {
    "autoRecharge": true,
    "high": {
      "value": "<string>"
    },
    "low": {
      "value": "<string>"
    },
    "transaction": {
      "amount": {
        "value": "<string>"
      },
      "createTime": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "id": "<string>",
      "lastPaymentError": {
        "code": "<string>",
        "declineCode": "<string>"
      },
      "latestCharge": {
        "amount": {
          "value": "<string>"
        },
        "createTime": "2023-11-07T05:31:56Z",
        "paid": true,
        "refunded": true,
        "status": "<string>",
        "failureCode": "<string>"
      },
      "status": "<string>",
      "succeeded": true
    }
  },
  "deleteTime": "2023-11-07T05:31:56Z",
  "displayName": "<string>",
  "hourlySpendLimit": {
    "value": "<string>"
  },
  "hourlySpendRate": {
    "value": "<string>"
  },
  "id": "<string>",
  "invoiceTime": "2023-11-07T05:31:56Z",
  "monthlySpend": "<string>",
  "monthlySpendLimit": {
    "value": "<string>"
  },
  "nextInvoiceTotal": {
    "value": "<string>"
  },
  "paymentTerms": "PAYMENT_TERMS_UNSPECIFIED",
  "purgeTime": "2023-11-07T05:31:56Z",
  "state": "STATE_UNSPECIFIED",
  "stripeRef": "<string>",
  "taxId": {
    "id": "<string>",
    "type": "<string>",
    "value": "<string>"
  }
}

Authorizations

Authorization · string · header · required

API key authentication. API keys should be passed using the format Bearer API_KEY.

Body

application/json

displayName · string · required

email · string · required

billingAddress · object

Show child attributes

invoiceName · string

referral · string

taxId · object

Show child attributes

Response

200

application/json

A successful response.

billingAddress · object

Show child attributes

billingThreshold · object

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

Show child attributes

createBy · string · read-only

createTime · string<date-time> · read-only

creditBalance · object

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

Show child attributes

creditBalanceRecharge · object

Show child attributes

deleteTime · string<date-time> · read-only

displayName · string

hourlySpendLimit · object

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

Show child attributes

hourlySpendRate · object

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

Show child attributes

id · string · read-only

invoiceTime · string<date-time> · read-only

monthlySpend · string · read-only

monthlySpendLimit · object

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

Show child attributes

nextInvoiceTotal · object

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

Show child attributes

paymentTerms · enum<string> · default: PAYMENT_TERMS_UNSPECIFIED

Available options: PAYMENT_TERMS_UNSPECIFIED, PAYMENT_TERMS_PREPAID, PAYMENT_TERMS_INVOICE

purgeTime · string<date-time> · read-only

state · enum<string> · default: STATE_UNSPECIFIED

Available options: STATE_UNSPECIFIED, STATE_ACTIVE, STATE_SUSPENDED_ABUSE, STATE_SUSPENDED_PAYMENT, STATE_DELETED

stripeRef · string

taxId · object

Show child attributes