Skip to content

Commit 8aae55e

Browse files
docs: added notice for add and remove seats in changelog
1 parent 9a88a47 commit 8aae55e

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

docs/docs/changelog.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ vendors to use `v2` or `v3` of the API within the same version of the SDK.
1313

1414
**v4.0.0 implementation**
1515
```typescript
16-
const salable = new Salable('your-api-key', 'v2')
16+
const salable = new Salable('your-api-key', 'v2');
1717
```
1818
**v5.0.0 implementation**
1919
```typescript
20-
const salableV2 = initSalable('your-api-key', 'v2') // still supported
21-
const salableV3 = initSalable('your-api-key', 'v3')
20+
const salableV2 = initSalable('your-api-key', 'v2'); // v2 still supported
21+
const salableV3 = initSalable('your-api-key', 'v3');
2222
```
2323

2424
### V3 Breaking changes
@@ -51,6 +51,8 @@ consistent implementation across all types of subscriptions.
5151
#### Other deprecated endpoints
5252
- `products.getFeatures` moved to `features.getAll` with the `productUuid` filter applied.
5353
- `products.getPlans` moved to `plans.getAll` with the `productUuid` filter applied.
54+
- `subscriptions.addSeats` moved to `subscriptions.updateSeatCount` with `increment` set.
55+
- `subscriptions.removeSeats` moved to `subscriptions.updateSeatCount` with `decerement` set.
5456

5557
#### Affected responses
5658
- `products.getAll` now uses cursor-based pagination in the response.
@@ -59,6 +61,7 @@ consistent implementation across all types of subscriptions.
5961
#### New methods
6062
- `features.getAll` - Retrieves all features for an organisation. The response uses cursor-based pagination.
6163
- `plans.getAll` - Retrieves all plans for an organisation. The response uses cursor-based pagination.
64+
- `subscriptions.updateSeatCount` - v2 of the API required two different endpoints to add and remove seats on a per-seat subscription. In v3 this has been aligned under one method `subscriptions.updateSeatCount`.
6265
- `entitlements.check` - Check grantee access to specific features (replaces `licenses.check`).
6366

6467
**v4.0.0 SDK with API v2**

0 commit comments

Comments
 (0)