← Marketplace operations · All schemas
Create a new wallet charge — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
appId | string | Required within parent | App ID of the App |
companyId | string | Required within parent | ID of the Agency the Sub-account belongs to |
description | string | Required within parent | Description of the charge |
eventId | string | Required within parent | 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. |
eventTime | string | Optional | The timestamp when the event/transaction was performed. If blank, the billing timestamp will be set as the event time. ISO8601 Format. |
locationId | string | Required within parent | ID of the Sub-Account to be charged |
meterId | string | Required within parent | Billing Meter ID (you can find this on your app's pricing page) |
price | number | Optional | Price per unit to charge |
units | number | Required within parent | Number of units to charge |
userId | string | Optional | User ID |
Get Installer Details — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
installationDetails | JSON | Required within parent | Installation details |
installationDetails (allOf 1) | Model | All variants apply | Expand Get Installer Details — response body — installation Details company Email, company High Level Plan, company Id, company Name, company Owner Full Name, company Plan, is Whitelabel Company, location Id, marketplace App Plan Id, relationship Number, user Id, whitelabel Details |
Referenced models: Get Installer Details — response body — installation Details company Email, company High Level Plan, company Id, company Name, company Owner Full Name, company Plan, is Whitelabel Company, location Id, marketplace App Plan Id, relationship Number, user Id, whitelabel Details
Get Installer Details — response body — installation Details company Email, company High Level Plan, company Id, company Name, company Owner Full Name, company Plan, is Whitelabel Company, location Id, marketplace App Plan Id, relationship Number, user Id, whitelabel Details
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
companyEmail | JSON | Optional | |
companyEmail (anyOf 1) | string | Alternative | Company email. Will be null for sub-account installations due to PII concerns. |
companyEmail (anyOf 2) | null | Alternative | |
companyHighLevelPlan | JSON | Optional | |
companyHighLevelPlan (anyOf 1) | string | Alternative | Company plan. Will be null for sub-account installations due to business sensitivity. |
companyHighLevelPlan (anyOf 2) | null | Alternative | |
companyId | string | Required within parent | Company ID |
companyName | string | Required within parent | Company name |
companyOwnerFullName | JSON | Optional | |
companyOwnerFullName (anyOf 1) | string | Alternative | Company owner full name. Will be null for sub-account installations due to PII concerns. |
companyOwnerFullName (anyOf 2) | null | Alternative | |
companyPlan | JSON | Optional | |
companyPlan (anyOf 1) | string | Alternative | Company plan. Will be null for sub-account installations due to business sensitivity. |
companyPlan (anyOf 2) | null | Alternative | |
isWhitelabelCompany | boolean | Required within parent | Whether the company is a whitelabel company |
locationId | string | Optional | Location ID (if applicable) |
marketplaceAppPlanId | string | Optional | Marketplace app plan ID for paid apps |
relationshipNumber | string | Required within parent | Company relationship number |
userId | string | Required within parent | User ID who installed the app |
whitelabelDetails | JSON | Optional | Whitelabel details (only present if isWhitelabelCompany is true) |
whitelabelDetails (allOf 1) | Model | All variants apply | Expand Get Installer Details — response body — installation Details company Email, company High Level Plan, company Id, company Name, company Owner Full Name, company Plan, is Whitelabel Company, location Id, marketplace App Plan Id, relationship Number, user Id, whitelabel Details whitelabel Details domain, logo Url |
Referenced models: Get Installer Details — response body — installation Details company Email, company High Level Plan, company Id, company Name, company Owner Full Name, company Plan, is Whitelabel Company, location Id, marketplace App Plan Id, relationship Number, user Id, whitelabel Details whitelabel Details domain, logo Url
Get Installer Details — response body — installation Details company Email, company High Level Plan, company Id, company Name, company Owner Full Name, company Plan, is Whitelabel Company, location Id, marketplace App Plan Id, relationship Number, user Id, whitelabel Details whitelabel Details domain, logo Url
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
domain | string | Required within parent | Domain of the whitelabel company |
logoUrl | string | Required within parent | Logo URL of the whitelabel company |
Get all wallet charges — response body — charges item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
amountCharged | JSON | Optional | |
amountCharged (anyOf 1) | number | Alternative | Total amount charged |
amountCharged (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
appId | string | Optional | App ID |
chargeId | string | Optional | Charge ID |
createdAt | string | Optional | Timestamp when the charge was created in our system
Format: date-time |
currency | string | Optional | Currency of the transaction. We currently support USD only. |
entityId | string | Optional | If the entityType is Location, entityld would be locationld. |
entityType | string | Optional | Indicates who was charged? Currently, we support charges for 'location' only |
meta | object | Optional | meta object contains details that were sent while creating the charge via the API - eventID, description, eventTime, userld |
meterId | string | Optional | Billing Meter ID (you can find this on your app's pricing page) |
pricePerUnit | JSON | Optional | |
pricePerUnit (anyOf 1) | number | Alternative | Price per unit for the charge |
pricePerUnit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
refunded | boolean | Optional | Value is 'true' if the charge has subsequently been refunded. |
transactionType | string | Optional | This can be one of two values - 'charge' or 'refund' |
units | JSON | Optional | |
units (anyOf 1) | number | Alternative | Number of units that the sub-account was charged for |
units (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updatedAt | string | Optional | Timestamp when the charge was last updated in our system
Format: date-time |
Get rebilling config for an app subscription and usage plans — response body
Referenced models: Get rebilling config for an app subscription and usage plans — response body — plans subscription, usage
Get rebilling config for an app subscription and usage plans — response body — plans subscription, usage
Referenced models: Get rebilling config for an app subscription and usage plans — response body — plans subscription, usage subscription item, Get rebilling config for an app subscription and usage plans — response body — plans subscription, usage usage item
Get rebilling config for an app subscription and usage plans — response body — plans subscription, usage subscription item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
baseAmount | JSON | Required within parent | |
baseAmount (anyOf 1) | number | Alternative | The base amount |
baseAmount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
features | array | Required within parent | The features |
features[] | string | Each item | |
name | string | Required within parent | The plan name |
paymentTime | string | Required within parent | The payment time |
paymentType | string | Required within parent | The payment time |
planId | string | Required within parent | The plan id |
resellingAmount | JSON | Required within parent | |
resellingAmount (anyOf 1) | number | Alternative | The reselling amount |
resellingAmount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get rebilling config for an app subscription and usage plans — response body — plans subscription, usage usage item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
executionLimitPerCycle | JSON | Required within parent | |
executionLimitPerCycle (anyOf 1) | number | Alternative | The execution limit per cycle |
executionLimitPerCycle (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fixedPricePerUnit | JSON | Required within parent | |
fixedPricePerUnit (anyOf 1) | number | Alternative | The fixed price per unit, applicable for fixed price type |
fixedPricePerUnit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxPricePerUnit | string | Required within parent | The max price per unit, applicable for dynamic price type |
meterId | string | Required within parent | The meter id |
meterName | string | Required within parent | The meter name |
minPricePerUnit | string | Required within parent | The min price per unit, applicable for dynamic price type |
priceType | string | Required within parent | The price type
Known values: fixed, dynamic |
productName | string | Required within parent | The product name |
productType | string | Required within parent | The product type |
usageUnit | string | Required within parent | The usage unit for the meter |
Uninstall an application — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
companyId | string | Optional | The company id from which the application is to be uninstalled. If you pass agency token, then companyId is required. It will uninstall application from agency as well as all sub-accounts. |
locationId | string | Optional | The location id from which the application is to be uninstalled. If you pass location token, then locationId is required. It will uninstall application from that location only. |
reason | string | Optional | The reason for uninstalling the application. Reason is required if you are uninstalling the application as a developer. |
Uninstall an application — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
success | boolean | Required within parent | The status of the uninstallation of the application |
