Aller au contenu
NimbusNexus

Facturation

La facturation se fait par espace de travail. Ces endpoints lisent la situation du compte de l’espace de travail et tiennent à jour ses coordonnées de facturation :

  • GET /api/v1/billing/public/balances — les frais postpayés restant dus, le crédit promotionnel disponible et le solde des fonds prépayés, en un seul instantané.
  • GET /api/v1/billing/public/accrued_charges — le total facturé jusqu’à présent qui n’a pas encore été réglé.
  • GET /api/v1/billing/public/cash_balance — le solde des fonds prépayés, avec la date de sa dernière modification.
  • GET /api/v1/billing/public/promotion_grants — le crédit promotionnel actif, avec ce qui reste de chaque octroi et sa date d’expiration.
  • GET et PATCH /api/v1/billing/public/billing_info — l’adresse de facturation, le nom de la société et les adresses e-mail qui reçoivent les relevés et les reçus.

Les factures elles-mêmes ne sont pas disponibles via l’API.

Ces appels exigent une session connectée, transmise par Authorization: Bearer ou par le cookie de session. Une clé API ne peut pas les effectuer.

Étapes suivantes

Reference

GET/api/v1/billing/public/accrued_charges

Accrued Charges

Returns the total charges accrued by the current customer that have not yet been settled.

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/billing/public/accrued_charges" \
  -H "Authorization: Bearer $NIMBUS_KEY"
GET/api/v1/billing/public/balances

Get Balances

Returns the customer's outstanding postpaid charges, available promotional credit, and prepaid cash balance in a single snapshot.

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/billing/public/balances" \
  -H "Authorization: Bearer $NIMBUS_KEY"
GET/api/v1/billing/public/billing_info

Get Billing Info

Retrieves the billing address and notification email addresses for the current customer.

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/billing/public/billing_info" \
  -H "Authorization: Bearer $NIMBUS_KEY"
PATCH/api/v1/billing/public/billing_info

Update Billing Info

Updates the billing address, company name, and notification email addresses for the current customer.

Request body

FieldTypeDescription
companystring | null—
addressAddressModel | null—
statement_emailstring | null—
receipt_emailstring | null—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X PATCH "https://api.nimbusnexus.net/api/v1/billing/public/billing_info" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
GET/api/v1/billing/public/cash_balance

Get Cash Balance

Returns the current prepaid cash balance for the customer along with the timestamp it was last updated.

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/billing/public/cash_balance" \
  -H "Authorization: Bearer $NIMBUS_KEY"
GET/api/v1/billing/public/promotion_grants

List Promotion Grants

Lists the customer's active promotional credit grants with their remaining amounts and expiration dates.

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/billing/public/promotion_grants" \
  -H "Authorization: Bearer $NIMBUS_KEY"

Need to make a real call? Try these endpoints in the live Swagger UI →