SaaS
API Service for SaaS
Get Agency Plans
Fetch all agency subscription plans for a given company ID
Allow Attach Rebilling
Marks a SaaS sub-account as awaiting rebilling attach and optionally stores the rebilling configuration that should be applied when the rebilling config is created. Sets payment_pending on the sub-account. Only allowed when the sub-account is in setup_pending state.
Disable SaaS for locations
Disable SaaS for locations for given locationIds
Bulk Enable SaaS
Enable SaaS mode for multiple locations with support for both SaaS v1 and v2
Get Location Wallet Balance
Fetch the wallet balance for a specific location. Returns a resource object with balance details. **Deprecated:** this operation has moved to the Blade Platform API (`GET /wallet/company/balance?locationId={locationId}`, or `GET /wallet/balance` with a Sub-Account token) and will be removed from the SaaS API in the next version. Response shapes are unchanged, but no tenant id appears in the path: the agency comes from the token and the sub-account moves to a query parameter. Use the `wallet.readonly` scope.
Update Location Wallet Balance
Update the wallet balance or complimentary credit settings for a specific location. Supports partial updates via updateMask field (AIP-134 compliant). **Deprecated:** this operation has moved to the Blade Platform API (`POST /wallet/company/balance/complimentary-credits`) and will be removed from the SaaS API in the next version. Request and response shapes are unchanged except that `companyId` is resolved from the access token and `locationId` moves into the request body. Use an Agency access token carrying the `wallet.write` scope.
List agency wallet transactions
Fetch paginated wallet transactions for an agency (company). Supports skip/limit pagination, date-range and charge-type filters, timezone normalization, and additional non-indexed filters in the request body. **Deprecated:** this operation has moved to the Blade Platform API (`POST /wallet/company/transactions`) and will be removed from the SaaS API in the next version. Request and response shapes are unchanged, but `companyId` is no longer part of the URL -- the agency is resolved from the access token. Use an Agency access token carrying the `wallet.readonly` scope.
Enable SaaS for Sub-Account (Formerly Location)
Enable SaaS for Sub-Account (Formerly Location) based on the data provided
Get Location Subscription Details
Fetch subscription details for a specific location from location metadata
Get locations by stripeId with companyId
Get locations by stripeCustomerId or stripeSubscriptionId with companyId
List location wallet transactions
Fetch paginated wallet transactions for a sub-account (location). Supports skip/limit pagination, date-range and charge-type filters, timezone normalization, and additional non-indexed filters in the request body. **Deprecated:** this operation has moved to the Blade Platform API (`POST /wallet/transactions`) and will be removed from the SaaS API in the next version. Request and response shapes are unchanged, but the `locationId` is no longer part of the URL -- the sub-account is resolved from the access token. Use the `wallet.readonly` scope.
Pause location
Pause Sub account for given locationId
Remove attached config
Clears attached SaaS plan (attachPlanId/attachPriceId) and/or attached rebilling config from a sub-account in setup_pending, and sets suspendedInfo.payment_pending to false.
Get SaaS Locations
Fetch all SaaS-activated locations for a company with pagination
Get SaaS Plan
Fetch a specific SaaS plan by plan ID
Update Rebilling
Bulk update rebilling for given locationIds
Update SaaS subscription
Update SaaS subscription for given locationId and customerId