Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cariqa Billing Details API

The Billing Details API from Cariqa — 1 operation(s) for billing details.

Cariqa Billing Details API is one of 7 APIs that Cariqa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Billing Details. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and a quickstart.

This API exposes 2 operations across 1 path, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0 (v1).

Requests are made against 2 base URLs: https://connect.cariqa.com, https://dev.connect.cariqa.com.

2 operations 1 paths 6 schemas 1 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0 (v1)
Base URL
https://connect.cariqa.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Cariqa Billing Details API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — JWT Authorization header using the Bearer scheme.

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Billing Details 2
GET
/api/v1/users/{user_id}/billing-details/
Get Billing Details
users_billing_details_retrieve 1 param → 200403404
PUT
/api/v1/users/{user_id}/billing-details/
Update Billing Details
users_billing_details_update 1 param body → 200400403404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ConnectAPIBillingDetails (10 properties), Error (3 properties), ErrorDetail (2 properties), Detail (1 property). Each schema is shown below with its type and property counts.

ErrorDetail
object
2 properties 2 required
ErrorTypeEnum
string
validationerror - validationerror paymentmethoderror - paymentmethoderror paymenterror - paymenterror temporarylocked - temporarylocked alreadycharging - alrea…
Detail
object
400 status error message response serializer.
1 property 1 required
Error
object
3 properties 2 required
AccountTypeEnum
string
personal - personal business - business
ConnectAPIBillingDetails
object
Serializer which is used to serialize data with the possible business details if exist
10 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cariqa-billing-details-api-openapi.yml Raw ↑

Other APIs Cariqa publishes across the network.

Cariqa Charging Sessions API
Cariqa Debts API
Cariqa Invoices API
Cariqa Payments API
Cariqa Stations API
Cariqa Users API