Update payment terms

Only a platform administrator may change the selected workspace payment terms to prepaid or postpaid using compare-and-swap. Workspace billing management permission does not permit mode changes. Neither terms choice creates a subscription or retroactive charges.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

expectedVersion?string

The account version the change is based on, from WorkspaceBilling.version. A mismatch fails with a conflict.

Formatint64

paymentTerms?string

The new terms.

Value in"BILLING_PAYMENT_TERMS_UNSPECIFIED" | "BILLING_PAYMENT_TERMS_PREPAID" | "BILLING_PAYMENT_TERMS_POSTPAID"

Response Body

`application/json`

curl -X POST "https://api.goldmine.to/billing.v1.Billing/AdministratorUpdateBillingTerms" \  -H "Content-Type: application/json" \  -d '{}'

{
  "billing": {
    "amountDueCents": "string",
    "availableCreditCents": "string",
    "currency": "string",
    "currencyExponent": 0,
    "invoiceCreditCents": "string",
    "paymentTerms": "BILLING_PAYMENT_TERMS_UNSPECIFIED",
    "providerMode": "BILLING_PROVIDER_MODE_UNSPECIFIED",
    "unbilledUsageCents": "string",
    "version": "string"
  }
}

{
  "code": "invalid_argument",
  "message": "The request was malformed, such as a missing required field or an unparseable cursor."
}

{
  "code": "unauthenticated",
  "message": "The request lacks a valid API key in the Authorization header."
}

{
  "code": "permission_denied",
  "message": "The API key is not allowed to perform this action on this workspace."
}

{
  "code": "aborted",
  "message": "The operation was aborted, typically because of a concurrency conflict."
}

{
  "code": "internal",
  "message": "An internal server error occurred."
}

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

409application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`