---
title: "Get subscription settings"
method: GET
path: "/subscriptions/settings"
tags: ["Subscriptions"]
---

# Get subscription settings

`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`

Retrieves settings for a subscription.

## Response `200`

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

- SubscriptionSettings: Settings for an account's subscription behavior.
  - `href` string, nullable
  - `relation` string, nullable
  - `method` string, nullable
  - `self` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `id` string, nullable: The Smokeball firm id.
  - `createExpensesFromUsageCharges` boolean: Whether usage charges should create expenses/disbursements.
  - `usageAccessPermission` string: Controls which staff at the firm can access Usage-based Products.
  - `usageAccessSelectedUserIds` string[], nullable: Staff user ids granted access when Finance.Subscriptions.Api.Resources.SubscriptionSettings.UsageAccessPermission is Finance.Subscriptions.Entities.UsageAccessPermission.SelectedUsersAndFirmOwners.
  - `updatedDate` string, date-time, nullable: The date the settings were last updated.
  - `updatedByUserId` string, nullable: The user id that last updated the settings.

## Other responses

- `404`: When subscription with specified id does not exist.

---

[API](https://skmtc.dev/smokeball/apis/smokeball-api.md) - [All operations](https://skmtc.dev/smokeball/apis/smokeball-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smokeball/apis/smokeball-api/revisions/6e350cf667d4?raw)