Rapidata Billing API
The Billing API from Rapidata — 24 operation(s) for billing.
Rapidata Billing API is one of 55 APIs that Rapidata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Billing. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.
This API exposes 25 operations across 24 paths, and defines 52 schemas. It is described by OpenAPI 3.0.4, at version v1.
Requests are made against a single base URL, https://api.rapidata.ai/.
25 operations
24 paths
52 schemas
3 DELETE14 GET8 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Rapidata Billing API declares
1 security scheme
for authenticating requests.
It supports OpenID Connect (OpenIdConnect) discovered at https://auth.rapidata.ai/.well-known/openid-configuration.
OpenIdConnect— OpenID Connect connection flow
Paths & Operations 25
Across 24 paths, the API surfaces 25 operations — 3 DELETE, 14 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.
Billing 25
POST
/billing/manual-charge
Creates a manual charge billing item for a customer.
POST
/billing/external-service-prices
Creates a rate-card price for an external service.
GET
/billing-period/active/billing-items
Gets the paged billing groups for the active billing period.
GET
/billing-period/active
Gets the overview for the active billing period.
GET
/billing-period/{billingPeriodId}/billing-items
Gets the paged billing groups for a billing period.
GET
/billing-period/{billingPeriodId}
Gets the overview for a billing period by its ID.
GET
/billing/summary
Gets the current-period usage and applicable limit for a customer.
GET
/billing/cost/time-series
Gets the billing cost time series.
GET
/billing-periods
Queries billing periods accessible to the current customer.
GET
/billing/costs/customers
Returns billing costs aggregated per customer, ranked by cost.
GET
/billing/costs/groups
Returns billing costs aggregated per billing group, ranked by cost.
GET
/billing/costs/organizations
Returns billing costs aggregated per organization, ranked by cost.
GET
/billing/reconciliation/bulk/{bulkReconciliationId}
Returns the aggregated status and results of all reconciliation jobs in a bulk operation.
GET
/billing/reconciliation/{jobId}
Returns the status and results of a reconciliation job.
POST
/billing/reconciliation/bulk/{bulkReconciliationId}/redispatch
Redispatches the individual reconciliations contained in the given bulk reconciliation.
POST
/billing/reconcile
Starts reconciliation for a single billing item, all items for a customer, or all items in a billing group.
POST
/billing/billing-item/{billingItemId}/settings
Creates a billing setting for a billing item.
POST
/billing/customer/{customerId}/settings
Creates a billing setting for a customer.
POST
/billing/settings
Creates a global billing setting.
DELETE
/billing/billing-item/{billingItemId}/settings/{settingId}
Deletes a billing item billing setting.
DELETE
/billing/customer/{customerId}/settings/{settingId}
Deletes a customer billing setting.
DELETE
/billing/settings/{settingId}
Deletes a global billing setting.
GET
/billing/settings/timeline
Gets the billing settings timeline.
POST
/billing-period/{billingPeriodId}/volume-discounts
Creates a volume discount bracket for a billing period.
GET
/billing-period/{billingPeriodId}/volume-discounts
Gets all volume discount brackets for a billing period.
Schemas 52
The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are GetBulkReconciliationStatusEndpoint_Output (19 properties), GetReconciliationStatusEndpoint_Output (18 properties), CreateGlobalBillingSettingEndpoint_Input (14 properties), CreateBillingItemBillingSettingEndpoint_Input (14 properties). Each schema is shown below with its type and property counts.
ILineItemModelOtherChargeModel
object
5 properties
4 required
StartBulkReconciliationEndpoint_Input
object
6 properties
GetVolumeDiscountsEndpoint_Output
object
1 property
1 required
ILineItemModelRefundModel
object
5 properties
4 required
PagedResultOfIBillingGroupModel
object
5 properties
4 required
IBillingGroupModelBenchmarkBillingGroupModel
object
A billing group for responses produced by a benchmark.
8 properties
8 required
ILineItemModelVolumeDiscountModel
object
3 properties
3 required
GetCostTimeSeriesEndpoint_CostDataPoint
object
5 properties
5 required
IBillingGroupModel
object
A billable group of responses on a billing period, identified by a discriminator. Implementations describe the source of the charges (order, benchmark, audienc…
1 required
BillingSummaryMode
QueryCostsByCustomerEndpoint_PagedResultOfOutput
object
5 properties
4 required
CreateExternalServicePriceEndpoint_Input
object
The external-service price input data.
7 properties
3 required
ReconciliationJobState
IBillingGroupModelOrderBillingGroupModel
object
A billing group for responses produced by an order.
8 properties
8 required
GetVolumeDiscountsEndpoint_Output_VolumeDiscountItem
object
3 properties
3 required
ILineItemModelMinimumSpendCommitmentModel
object
5 properties
3 required
CreateVolumeDiscountEndpoint_Output
object
1 property
1 required
GetReconciliationStatusEndpoint_Output
object
18 properties
15 required
QueryCostsByCustomerEndpoint_Output
object
Billing cost data aggregated per customer.
6 properties
6 required
IBillingGroupModelRankingFlowBillingGroupModel
object
A billing group for responses produced by a ranking flow.
8 properties
8 required
ILineItemModelPlatformFeeModel
object
5 properties
4 required
ExternalServiceKind
BillingPeriodStatus
TimeGrouping
ValidationProblemDetails
object
6 properties
CreateManualChargeEndpoint_Input
object
7 properties
6 required
CreateVolumeDiscountEndpoint_Input
object
2 properties
2 required
BillingPeriodStatusModel
ILineItemModelRunningCostModel
object
2 properties
2 required
IBillingGroupModelValidationSetBillingGroupModel
object
A billing group for responses produced by a validation set.
8 properties
8 required
QueryBillingPeriodsEndpoint_Output
object
6 properties
6 required
GetBillingPeriodOverviewEndpoint_Output
object
9 properties
9 required
GetCostTimeSeriesEndpoint_Output
object
The output for the cost time series endpoint.
4 properties
4 required
GetBillingSettingsTimelineEndpoint_Output_Interval
object
13 properties
11 required
CreateManualChargeEndpoint_Output
object
1 property
1 required
ReconciliationTimestampMode
StartBulkReconciliationEndpoint_Output
object
1 property
1 required
ManualChargeReason
BulkReconciliationDispatchState
IBillingGroupModelAudienceJobBillingGroupModel
object
A billing group for responses produced by an audience job.
9 properties
9 required
QueryCostsByOrganizationEndpoint_PagedResultOfOutput
object
5 properties
4 required
QueryBillingPeriodsEndpoint_PagedResultOfOutput
object
5 properties
4 required
CreateCustomerBillingSettingEndpoint_Input
object
The billing setting input data.
14 properties
QueryCostsByOrganizationEndpoint_Output
object
Billing cost data aggregated per organization.
6 properties
6 required
ILineItemModel
object
1 required
GetBillingSettingsTimelineEndpoint_Output
object
1 property
1 required
GetBulkReconciliationStatusEndpoint_Output
object
19 properties
17 required
GetActiveBillingPeriodOverviewEndpoint_Output
object
9 properties
9 required
IBillingGroupModelAudienceDistillationBillingGroupModel
object
A billing group for responses produced by an audience distillation run.
8 properties
8 required
CreateBillingItemBillingSettingEndpoint_Input
object
The billing setting input data.
14 properties
CreateGlobalBillingSettingEndpoint_Input
object
The billing setting input data.
14 properties
GetBillingSummaryEndpoint_Output
object
5 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Rapidata 12
Other APIs Rapidata publishes across the network.
Rapidata Asset API
Rapidata Audience API
Rapidata BatchUpload API
Rapidata Benchmark API
Rapidata BillingAccount API
Rapidata Cache API
Rapidata Campaign API
Rapidata Client API
Rapidata ContextShortening API
Rapidata Customer API
Rapidata CustomerRapid API
Rapidata Datapoints API
#Billing