Skip to content

docs: reorder and rename subscription methods #149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
avst-perrygeorge wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: reorder and rename subscription methods #149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
301fc20
docs: reorder and rename subscription methods
avst-perrygeorge May 21, 2025
7506946
docs: updated text on get user plans
avst-perrygeorge May 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/docs/subscriptions/add-seats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
sidebar_position: 12
sidebar_position: 11
---

# Increment Subscription Seats
# Add seats

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.
Adds seats to a Subscription. Initially, the seats will be unassigned. To assign grantees to the seats, use the [manage seats](./manage-seats.md) method.

## Code Sample

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/subscriptions/cancel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
sidebar_position: 6
sidebar_position: 17
---

# Cancel a Subscription
# Cancel

Cancels a Subscription with options for when it terminates.

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/subscriptions/change-plan.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
sidebar_position: 3
sidebar_position: 14
---

# Change a Subscription's Plan
# Change plan

Move a Subscription to a new Plan. Proration behaviour can optionally be set.
Move a Subscription to a new Plan. If the subscription was created through a checkout link, proration behaviour can optionally be set.
Copy link
Contributor

@Glazy Glazy May 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The second half of this is a tricky one. It is unclear how it relates to the ability to "Change plan", can the proration behaviour be changed at this point?

Copy link
Contributor Author

@avst-perrygeorge avst-perrygeorge May 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

proration behaviour isn't defined on a subscription level, its just defined for the action. So in this case proration will be applied to just this specific change plan action.


## Code Sample

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/subscriptions/create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 1
---

# Create Subscription
# Create

Create a subscription with no payment integration.

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/subscriptions/get-all.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
sidebar_position: 1
sidebar_position: 2
---

# Get All Subscriptions
# Get all

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

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/subscriptions/get-cancel-subscription-link.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 9
---

# Get Cancel Subscription Link
# Get cancel link

Returns a link to cancel a specific subscription.

Expand All @@ -26,4 +26,4 @@ The UUID of the subscription

## Return Type

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)
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)
2 changes: 1 addition & 1 deletion docs/docs/subscriptions/get-count.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 5
---

# Get Subscription Seat Count
# Get seat count

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.

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/subscriptions/get-customer-portal-link.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
sidebar_position: 8
sidebar_position: 9
---

# Get a Customer Portal Link for a Subscription
# Get customer portal link

Returns the customer portal link for a subscription.

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

## Return Type

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)
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)
4 changes: 2 additions & 2 deletions docs/docs/subscriptions/get-invoices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 4
sidebar_position: 7
---

# Get Subscription Invoices
Expand Down Expand Up @@ -35,4 +35,4 @@ _Type:_ `GetAllInvoicesOptions`

## Return Type

For more information about this request see our API documentation on [Subscription Invoice Object](https://docs.salable.app/api/v2#tag/Subscriptions/operation/getSubscriptionInvoices)
For more information about this request, see our API documentation on [Subscription Invoice Object](https://docs.salable.app/api/v2#tag/Subscriptions/operation/getSubscriptionInvoices)
4 changes: 2 additions & 2 deletions docs/docs/subscriptions/get-one.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
sidebar_position: 2
sidebar_position: 3
---

# Get One Subscription
# Get a subscription

Returns the details of a single subscription.

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/subscriptions/get-payment-link.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
sidebar_position: 7
sidebar_position: 10
---

# Get a Subscription Update Payment Link
# Get update payment link

Returns the update payment link for a specific subscription.

Expand All @@ -26,4 +26,4 @@ The UUID of the subscription

## Return Type

For more information about this request see our API documentation on [Subscription Payment Link Object](https://docs.salable.app/api/v2#tag/Subscriptions/operation/getSubscriptionUpdatePaymentLink)
For more information about this request, see our API documentation on [Subscription Payment Link Object](https://docs.salable.app/api/v2#tag/Subscriptions/operation/getSubscriptionUpdatePaymentLink)
6 changes: 3 additions & 3 deletions docs/docs/subscriptions/get-payment-method.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
sidebar_position: 10
sidebar_position: 8
---

# Get a Subscription Payment Method
# Get payment method

Returns the payment method used to pay for a subscription.

Expand All @@ -26,4 +26,4 @@ The UUID of the subscription

## Return Type

For more information about this request see our API documentation on [Subscription Payment Method Object](https://docs.salable.app/api/v2#tag/Subscriptions/operation/getSubscriptionPaymentMethod)
For more information about this request, see our API documentation on [Subscription Payment Method Object](https://docs.salable.app/api/v2#tag/Subscriptions/operation/getSubscriptionPaymentMethod)
4 changes: 2 additions & 2 deletions docs/docs/subscriptions/get-seats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
sidebar_position: 1
sidebar_position: 4
---

# Get Subscription Seats
# Get seats

Returns a list of seats on a subscription. Seats with the status `CANCELED` are ignored. Response uses cursor-based pagination.

Expand Down
8 changes: 4 additions & 4 deletions docs/docs/subscriptions/get-user-plans.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
sidebar_position: 5
sidebar_position: 6
---

# Get Switchable Plans for a Subscribed User
# Get switchable plans

Returns the details of a single subscription.
Returns the available plans the customer on the subscription can switch to.

## Code Sample

Expand All @@ -26,4 +26,4 @@ The UUID of the subscription

## Return Type

For more information about this request see our API documentation on [Subscription Object](https://docs.salable.app/api/v2#tag/Subscriptions/operation/getSubscriptionUpdatablePlans)
For more information about this request, see our API documentation on [Subscription Object](https://docs.salable.app/api/v2#tag/Subscriptions/operation/getSubscriptionUpdatablePlans)
4 changes: 2 additions & 2 deletions docs/docs/subscriptions/reactivate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
sidebar_position: 11
sidebar_position: 15
---

# Reactivate a Subscription
# Reactivate

This method reactivates a subscription scheduled for cancellation before the billing period has passed.

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/subscriptions/remove-seats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
sidebar_position: 13
sidebar_position: 12
---

# Remove Subscription Seats
# Remove seats

Remove seats from a Subscription. Seats can only be removed if they are unassigned. To unassign seats use the [update many](../licenses/update-many.md) method to set the `granteeId` of each seat to `null`.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/subscriptions/update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 13
---

# Update Subscription
# Update subscription

Update properties on a subscription.

Expand Down
Loading