v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Subscriptions

Get subscription settings

Retrieves settings for a subscription.

get/subscriptions/settings

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 a firm can use Usage-based Products. Missing settings should be treated as Finance.Subscriptions.Entities.UsageAccessPermission.All.

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.