Skip to main content
POST
Create a charge basket

Request Structure

Required Fields

Optional Fields

Important Notes

  • Each account typically has one open basket at a time
  • The invoice_status field is system-managed and cannot be set via the API

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

FlowAuthorization Code
Authorization URL
https://clarus-api.com/oauth/authorize
Token URL
https://clarus-api.com/oauth/token
FlowClient Credentials
Token URL
https://clarus-api.com/oauth/token
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Body

application/json
data
object
required

Response

Charge Basket created successfully

data
object