SMsmokeball
Subscriptions

Get subscription settings

Retrieves settings for a subscription.

get/subscriptions/settings

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/subscriptions/settings
  • Auth
    API key in header x-api-key and API key in header Authorization

Response

When request is successful. Returns a 'SubscriptionSettings' object.

hrefstring nullable
relationstring nullable
methodstring nullable
idstring nullable

The Smokeball firm id.

createExpensesFromUsageChargesboolean

Whether usage charges should create expenses/disbursements.

usageAccessPermissionstring

Controls which staff at the firm can access Usage-based Products.

usageAccessSelectedUserIdsstring[] nullable

Staff user ids granted access when Finance.Subscriptions.Api.Resources.SubscriptionSettings.UsageAccessPermission is Finance.Subscriptions.Entities.UsageAccessPermission.SelectedUsersAndFirmOwners.

updatedDatestring date-time nullable

The date the settings were last updated.

updatedByUserIdstring nullable

The user id that last updated the settings.

Changes

No recorded changes to this operation across all 15 revisions of this API.