Boxc Users API
The Users resources allows an application to retrieve information about the tokenized user such as balances, personal/company address, and subscriptions. Only the addresses can be updated by applications### SubscriptionsA subscription is a recurring payment for a provided service. The specified `amount` is deducted from the user's BoxC balance at the start of each `interval` - also known as `current_period_start`.- Applications can only view subscriptions that belong to them.- Subscriptions automatically renew each interval until cancelled.- Cancelling a subscription will flag it to be deleted after `current_period_end`. To save a subscription it must be renewed before `current_period_end`.- Subscriptions are automatically removed from the list if their `current_period_end` is less than the current time.- A subscription cannot be modified after creation - only renewed.- A subscription will not be renewed if the user has insufficient funds.- A subscription can only be cancelled by the user from their account's dashboard.
Boxc Users API is one of 22 APIs that Boxc publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 2 operations across 1 path, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 1.123.
Requests are made against a single base URL, https://api.boxc.com/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Boxc Users API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (JWT).
It accepts HTTP bearer tokens (PrivilegedClient).
JWT— All operations require a JSON Web Token after completing an [OAuth2 flow](tag/Authentication).PrivilegedClient— Some clients require special privileges to use operations. No additional scope is needed.
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.
The Users resources allows an application to retrieve information about the tokenized user such as balances, personal/company address, and subscriptions. Only the addresses can be…
Schemas 14
The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are subscription (11 properties), user (9 properties), address (7 properties), bad-request (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Boxc 12
Other APIs Boxc publishes across the network.
This is an independent, third-party profile of Boxc Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.