Skip to main content
Wallet ChargesVersion: v3

Create a new wallet charge

POST/marketplace/billing/charges

Create a new wallet charge

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:charges.write
Auth method:OAuth
Token type:Sub-Account Token

Request​

Body

application/json
appIdstringrequired

App ID of the App

Example:6578278e879ad2646715ba9c
meterIdstringrequired

Billing Meter ID (you can find this on your app's pricing page)

Example:680b97022b4a34420f5f9b93
eventIdstringrequired

Event ID / Transaction ID on your server's side. This will help you maintain the reference of the event/transaction on your end that you charged the customer for.

Example:evt_abc123
userIdstring

User ID

Example:user_abc123
locationIdstringrequired

ID of the Sub-Account to be charged

Example:ve9EPM428h8vShlRW1KT
companyIdstringrequired

ID of the Agency the Sub-account belongs to

Example:company_abc123
descriptionstringrequired

Description of the charge

Example:Charge for sending 10 SMS messages
pricenumber

Price per unit to charge

Example:0.01
unitsnumberrequired

Number of units to charge

Example:10
eventTimestring

The timestamp when the event/transaction was performed. If blank, the billing timestamp will be set as the event time. ISO8601 Format.

Example:2025-03-26T00:00:000Z

Response

application/json

Charge created successfully

successboolean

Indicates whether the charge was created successfully

Example:true
chargeIdstring

Unique identifier of the created charge

Example:charge_123