7.3 KiB
7.3 KiB
name, description
| name | description |
|---|---|
| billing-routes | Handle 24 OpenAPI operation(s) under /v1/billing for the billing route group. |
billing API Routes
Handle 24 OpenAPI operation(s) under /v1/billing for the billing route group.
Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.
Operations
get_billing_alerts
- Operation ID:
get_billing_alerts - Route:
GET /v1/billing/alerts - Mode: READ
- Summary: List billing alerts
- Parameters:
alert_typeinqueryending_beforeinqueryexpandinquerylimitinquerymeterinquerystarting_afterinquery
- Body: JSON request body accepted.
post_billing_alerts
- Operation ID:
post_billing_alerts - Route:
POST /v1/billing/alerts - Mode: WRITE
- Summary: Create a billing alert
- Body: JSON request body accepted.
get_billing_alerts_id
- Operation ID:
get_billing_alerts_id - Route:
GET /v1/billing/alerts/{id} - Mode: READ
- Summary: Retrieve a billing alert
- Parameters:
expandinqueryidinpathrequired
- Body: JSON request body accepted.
post_billing_alerts_id_activate
- Operation ID:
post_billing_alerts_id_activate - Route:
POST /v1/billing/alerts/{id}/activate - Mode: WRITE
- Summary: Activate a billing alert
- Parameters:
idinpathrequired
- Body: JSON request body accepted.
post_billing_alerts_id_archive
- Operation ID:
post_billing_alerts_id_archive - Route:
POST /v1/billing/alerts/{id}/archive - Mode: WRITE
- Summary: Archive a billing alert
- Parameters:
idinpathrequired
- Body: JSON request body accepted.
post_billing_alerts_id_deactivate
- Operation ID:
post_billing_alerts_id_deactivate - Route:
POST /v1/billing/alerts/{id}/deactivate - Mode: WRITE
- Summary: Deactivate a billing alert
- Parameters:
idinpathrequired
- Body: JSON request body accepted.
get_billing_credit_balance_summary
- Operation ID:
get_billing_credit_balance_summary - Route:
GET /v1/billing/credit_balance_summary - Mode: READ
- Summary: Retrieve the credit balance summary for a customer
- Parameters:
customerinquerycustomer_accountinqueryexpandinqueryfilterinqueryrequired
- Body: JSON request body accepted.
get_billing_credit_balance_transactions
- Operation ID:
get_billing_credit_balance_transactions - Route:
GET /v1/billing/credit_balance_transactions - Mode: READ
- Summary: List credit balance transactions
- Parameters:
credit_grantinquerycustomerinquerycustomer_accountinqueryending_beforeinqueryexpandinquerylimitinquerystarting_afterinquery
- Body: JSON request body accepted.
get_billing_credit_balance_transactions_id
- Operation ID:
get_billing_credit_balance_transactions_id - Route:
GET /v1/billing/credit_balance_transactions/{id} - Mode: READ
- Summary: Retrieve a credit balance transaction
- Parameters:
expandinqueryidinpathrequired
- Body: JSON request body accepted.
get_billing_credit_grants
- Operation ID:
get_billing_credit_grants - Route:
GET /v1/billing/credit_grants - Mode: READ
- Summary: List credit grants
- Parameters:
customerinquerycustomer_accountinqueryending_beforeinqueryexpandinquerylimitinquerystarting_afterinquery
- Body: JSON request body accepted.
post_billing_credit_grants
- Operation ID:
post_billing_credit_grants - Route:
POST /v1/billing/credit_grants - Mode: WRITE
- Summary: Create a credit grant
- Body: JSON request body accepted.
get_billing_credit_grants_id
- Operation ID:
get_billing_credit_grants_id - Route:
GET /v1/billing/credit_grants/{id} - Mode: READ
- Summary: Retrieve a credit grant
- Parameters:
expandinqueryidinpathrequired
- Body: JSON request body accepted.
post_billing_credit_grants_id
- Operation ID:
post_billing_credit_grants_id - Route:
POST /v1/billing/credit_grants/{id} - Mode: WRITE
- Summary: Update a credit grant
- Parameters:
idinpathrequired
- Body: JSON request body accepted.
post_billing_credit_grants_id_expire
- Operation ID:
post_billing_credit_grants_id_expire - Route:
POST /v1/billing/credit_grants/{id}/expire - Mode: WRITE
- Summary: Expire a credit grant
- Parameters:
idinpathrequired
- Body: JSON request body accepted.
post_billing_credit_grants_id_void
- Operation ID:
post_billing_credit_grants_id_void - Route:
POST /v1/billing/credit_grants/{id}/void - Mode: WRITE
- Summary: Void a credit grant
- Parameters:
idinpathrequired
- Body: JSON request body accepted.
post_billing_meter_event_adjustments
- Operation ID:
post_billing_meter_event_adjustments - Route:
POST /v1/billing/meter_event_adjustments - Mode: WRITE
- Summary: Create a billing meter event adjustment
- Body: JSON request body accepted.
post_billing_meter_events
- Operation ID:
post_billing_meter_events - Route:
POST /v1/billing/meter_events - Mode: WRITE
- Summary: Create a billing meter event
- Body: JSON request body accepted.
get_billing_meters
- Operation ID:
get_billing_meters - Route:
GET /v1/billing/meters - Mode: READ
- Summary: List billing meters
- Parameters:
ending_beforeinqueryexpandinquerylimitinquerystarting_afterinquerystatusinquery
- Body: JSON request body accepted.
post_billing_meters
- Operation ID:
post_billing_meters - Route:
POST /v1/billing/meters - Mode: WRITE
- Summary: Create a billing meter
- Body: JSON request body accepted.
get_billing_meters_id
- Operation ID:
get_billing_meters_id - Route:
GET /v1/billing/meters/{id} - Mode: READ
- Summary: Retrieve a billing meter
- Parameters:
expandinqueryidinpathrequired
- Body: JSON request body accepted.
post_billing_meters_id
- Operation ID:
post_billing_meters_id - Route:
POST /v1/billing/meters/{id} - Mode: WRITE
- Summary: Update a billing meter
- Parameters:
idinpathrequired
- Body: JSON request body accepted.
post_billing_meters_id_deactivate
- Operation ID:
post_billing_meters_id_deactivate - Route:
POST /v1/billing/meters/{id}/deactivate - Mode: WRITE
- Summary: Deactivate a billing meter
- Parameters:
idinpathrequired
- Body: JSON request body accepted.
get_billing_meters_id_event_summaries
- Operation ID:
get_billing_meters_id_event_summaries - Route:
GET /v1/billing/meters/{id}/event_summaries - Mode: READ
- Summary: List billing meter event summaries
- Parameters:
customerinqueryrequiredend_timeinqueryrequiredending_beforeinqueryexpandinqueryidinpathrequiredlimitinquerystart_timeinqueryrequiredstarting_afterinqueryvalue_grouping_windowinquery
- Body: JSON request body accepted.
post_billing_meters_id_reactivate
- Operation ID:
post_billing_meters_id_reactivate - Route:
POST /v1/billing/meters/{id}/reactivate - Mode: WRITE
- Summary: Reactivate a billing meter
- Parameters:
idinpathrequired
- Body: JSON request body accepted.