Skip to content
This repository was archived by the owner on Aug 3, 2026. It is now read-only.

Commit 301fc20

Browse files
docs: reorder and rename subscription methods
1 parent 4e3ea6f commit 301fc20

17 files changed

Lines changed: 38 additions & 38 deletions

docs/docs/subscriptions/add-seats.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
sidebar_position: 12
2+
sidebar_position: 11
33
---
44

5-
# Increment Subscription Seats
5+
# Add seats
66

7-
Adds seats to a Subscription. Initially the seats will be unassigned. To assign granteeIds to the seats use the [update many](../licenses/update-many.md) method.
7+
Adds seats to a Subscription. Initially, the seats will be unassigned. To assign granteeIds to the seats, use the [manage seats](./manage-seats.md) method.
88

99
## Code Sample
1010

docs/docs/subscriptions/cancel.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
sidebar_position: 6
2+
sidebar_position: 17
33
---
44

5-
# Cancel a Subscription
5+
# Cancel
66

77
Cancels a Subscription with options for when it terminates.
88

docs/docs/subscriptions/change-plan.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
sidebar_position: 3
2+
sidebar_position: 14
33
---
44

5-
# Change a Subscription's Plan
5+
# Change plan
66

7-
Move a Subscription to a new Plan. Proration behaviour can optionally be set.
7+
Move a Subscription to a new Plan. If the subscription was created through a checkout link, proration behaviour can optionally be set.
88

99
## Code Sample
1010

docs/docs/subscriptions/create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 1
33
---
44

5-
# Create Subscription
5+
# Create
66

77
Create a subscription with no payment integration.
88

docs/docs/subscriptions/get-all.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
sidebar_position: 1
2+
sidebar_position: 2
33
---
44

5-
# Get All Subscriptions
5+
# Get all
66

77
Returns a list of all the subscriptions created by your Salable organization.
88

docs/docs/subscriptions/get-cancel-subscription-link.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 9
33
---
44

5-
# Get Cancel Subscription Link
5+
# Get cancel link
66

77
Returns a link to cancel a specific subscription.
88

@@ -26,4 +26,4 @@ The UUID of the subscription
2626

2727
## Return Type
2828

29-
For more information about this request see our API documentation on [Cancel Subscription Link Object](https://docs.salable.app/api/v2#tag/Subscriptions/operation/getSubscriptionCancelLink)
29+
For more information about this request, see our API documentation on [Cancel Subscription Link Object](https://docs.salable.app/api/v2#tag/Subscriptions/operation/getSubscriptionCancelLink)

docs/docs/subscriptions/get-count.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 5
33
---
44

5-
# Get Subscription Seat Count
5+
# Get seat count
66

77
This method returns the aggregate number of seats. The response is broken down by assigned, unassigned and the total. Seats with the status `CANCELED` are ignored.
88

docs/docs/subscriptions/get-customer-portal-link.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
sidebar_position: 8
2+
sidebar_position: 9
33
---
44

5-
# Get a Customer Portal Link for a Subscription
5+
# Get customer portal link
66

77
Returns the customer portal link for a subscription.
88

@@ -26,4 +26,4 @@ The UUID of the subscription to be returned
2626

2727
## Return Type
2828

29-
For more information about this request see our API documentation on [Subscription Portal Link Object](https://docs.salable.app/api/v2#tag/Subscriptions/operation/getSubscriptionCustomerPortalLink)
29+
For more information about this request, see our API documentation on [Subscription Portal Link Object](https://docs.salable.app/api/v2#tag/Subscriptions/operation/getSubscriptionCustomerPortalLink)

docs/docs/subscriptions/get-invoices.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 4
2+
sidebar_position: 7
33
---
44

55
# Get Subscription Invoices
@@ -35,4 +35,4 @@ _Type:_ `GetAllInvoicesOptions`
3535

3636
## Return Type
3737

38-
For more information about this request see our API documentation on [Subscription Invoice Object](https://docs.salable.app/api/v2#tag/Subscriptions/operation/getSubscriptionInvoices)
38+
For more information about this request, see our API documentation on [Subscription Invoice Object](https://docs.salable.app/api/v2#tag/Subscriptions/operation/getSubscriptionInvoices)

docs/docs/subscriptions/get-one.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
sidebar_position: 2
2+
sidebar_position: 3
33
---
44

5-
# Get One Subscription
5+
# Get a subscription
66

77
Returns the details of a single subscription.
88

0 commit comments

Comments
 (0)