Create a new wallet charge

POST 
/marketplace/billing/charges

Create a new wallet charge

Request

application/json

application/json

Body

Bodyrequired

appIdstringrequired

App ID of the App

meterIdstringrequired

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

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.

userIdstring

User ID

locationIdstringrequired

ID of the Sub-Account to be charged

companyIdstringrequired

ID of the Agency the Sub-account belongs to

descriptionstringrequired

Description of the charge

pricenumber

Price per unit to charge

unitsnumberrequired

Number of units to charge

eventTimestring

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

Example (auto)

{
  "appId": "6578278e879ad2646715ba9c",
  "meterId": "680b97022b4a34420f5f9b93",
  "eventId": "evt_abc123",
  "userId": "user_abc123",
  "locationId": "ve9EPM428h8vShlRW1KT",
  "companyId": "company_abc123",
  "description": "Charge for sending 10 SMS messages",
  "price": 0.01,
  "units": 10,
  "eventTime": "2025-03-26T00:00:000Z"
}

application/json

Charge created successfully

application/json

Schema

Schema

successboolean

Indicates whether the charge was created successfully

chargeIdstring

Unique identifier of the created charge

Example (auto)

{
  "success": true,
  "chargeId": "charge_123"
}