From 301fc205d8c47a8b773f62e5a48abfd877ad8eda Mon Sep 17 00:00:00 2001 From: Perry George Date: Wed, 21 May 2025 15:49:00 +0100 Subject: [PATCH 1/2] docs: reorder and rename subscription methods --- docs/docs/subscriptions/add-seats.md | 6 +++--- docs/docs/subscriptions/cancel.md | 4 ++-- docs/docs/subscriptions/change-plan.md | 6 +++--- docs/docs/subscriptions/create.md | 2 +- docs/docs/subscriptions/get-all.md | 4 ++-- docs/docs/subscriptions/get-cancel-subscription-link.md | 4 ++-- docs/docs/subscriptions/get-count.md | 2 +- docs/docs/subscriptions/get-customer-portal-link.md | 6 +++--- docs/docs/subscriptions/get-invoices.md | 4 ++-- docs/docs/subscriptions/get-one.md | 4 ++-- docs/docs/subscriptions/get-payment-link.md | 6 +++--- docs/docs/subscriptions/get-payment-method.md | 6 +++--- docs/docs/subscriptions/get-seats.md | 4 ++-- docs/docs/subscriptions/get-user-plans.md | 8 ++++---- docs/docs/subscriptions/reactivate.md | 4 ++-- docs/docs/subscriptions/remove-seats.md | 4 ++-- docs/docs/subscriptions/update.md | 2 +- 17 files changed, 38 insertions(+), 38 deletions(-) diff --git a/docs/docs/subscriptions/add-seats.md b/docs/docs/subscriptions/add-seats.md index c176a7e..9e18820 100644 --- a/docs/docs/subscriptions/add-seats.md +++ b/docs/docs/subscriptions/add-seats.md @@ -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 granteeIds to the seats, use the [manage seats](./manage-seats.md) method. ## Code Sample diff --git a/docs/docs/subscriptions/cancel.md b/docs/docs/subscriptions/cancel.md index 9b442f4..711b539 100644 --- a/docs/docs/subscriptions/cancel.md +++ b/docs/docs/subscriptions/cancel.md @@ -1,8 +1,8 @@ --- -sidebar_position: 6 +sidebar_position: 17 --- -# Cancel a Subscription +# Cancel Cancels a Subscription with options for when it terminates. diff --git a/docs/docs/subscriptions/change-plan.md b/docs/docs/subscriptions/change-plan.md index 56fd349..579c9e7 100644 --- a/docs/docs/subscriptions/change-plan.md +++ b/docs/docs/subscriptions/change-plan.md @@ -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. ## Code Sample diff --git a/docs/docs/subscriptions/create.md b/docs/docs/subscriptions/create.md index 49cfecc..0d90c4d 100644 --- a/docs/docs/subscriptions/create.md +++ b/docs/docs/subscriptions/create.md @@ -2,7 +2,7 @@ sidebar_position: 1 --- -# Create Subscription +# Create Create a subscription with no payment integration. diff --git a/docs/docs/subscriptions/get-all.md b/docs/docs/subscriptions/get-all.md index 9508761..eb5621c 100644 --- a/docs/docs/subscriptions/get-all.md +++ b/docs/docs/subscriptions/get-all.md @@ -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. diff --git a/docs/docs/subscriptions/get-cancel-subscription-link.md b/docs/docs/subscriptions/get-cancel-subscription-link.md index 30f1401..00acc8f 100644 --- a/docs/docs/subscriptions/get-cancel-subscription-link.md +++ b/docs/docs/subscriptions/get-cancel-subscription-link.md @@ -2,7 +2,7 @@ sidebar_position: 9 --- -# Get Cancel Subscription Link +# Get cancel link Returns a link to cancel a specific subscription. @@ -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) diff --git a/docs/docs/subscriptions/get-count.md b/docs/docs/subscriptions/get-count.md index 6ede841..52828c9 100644 --- a/docs/docs/subscriptions/get-count.md +++ b/docs/docs/subscriptions/get-count.md @@ -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. diff --git a/docs/docs/subscriptions/get-customer-portal-link.md b/docs/docs/subscriptions/get-customer-portal-link.md index c3affaf..9bea4b8 100644 --- a/docs/docs/subscriptions/get-customer-portal-link.md +++ b/docs/docs/subscriptions/get-customer-portal-link.md @@ -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. @@ -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) diff --git a/docs/docs/subscriptions/get-invoices.md b/docs/docs/subscriptions/get-invoices.md index 9ad3f0b..ba058bc 100644 --- a/docs/docs/subscriptions/get-invoices.md +++ b/docs/docs/subscriptions/get-invoices.md @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 7 --- # Get Subscription Invoices @@ -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) diff --git a/docs/docs/subscriptions/get-one.md b/docs/docs/subscriptions/get-one.md index 3793d54..54bbcae 100644 --- a/docs/docs/subscriptions/get-one.md +++ b/docs/docs/subscriptions/get-one.md @@ -1,8 +1,8 @@ --- -sidebar_position: 2 +sidebar_position: 3 --- -# Get One Subscription +# Get a subscription Returns the details of a single subscription. diff --git a/docs/docs/subscriptions/get-payment-link.md b/docs/docs/subscriptions/get-payment-link.md index 68cb2fa..b23a9d0 100644 --- a/docs/docs/subscriptions/get-payment-link.md +++ b/docs/docs/subscriptions/get-payment-link.md @@ -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. @@ -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) diff --git a/docs/docs/subscriptions/get-payment-method.md b/docs/docs/subscriptions/get-payment-method.md index 636b6e6..04117a0 100644 --- a/docs/docs/subscriptions/get-payment-method.md +++ b/docs/docs/subscriptions/get-payment-method.md @@ -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. @@ -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) diff --git a/docs/docs/subscriptions/get-seats.md b/docs/docs/subscriptions/get-seats.md index 44102c0..46d942d 100644 --- a/docs/docs/subscriptions/get-seats.md +++ b/docs/docs/subscriptions/get-seats.md @@ -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. diff --git a/docs/docs/subscriptions/get-user-plans.md b/docs/docs/subscriptions/get-user-plans.md index 16b7271..1f76ab4 100644 --- a/docs/docs/subscriptions/get-user-plans.md +++ b/docs/docs/subscriptions/get-user-plans.md @@ -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 change to. ## Code Sample @@ -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) diff --git a/docs/docs/subscriptions/reactivate.md b/docs/docs/subscriptions/reactivate.md index 478d0e9..a24410d 100644 --- a/docs/docs/subscriptions/reactivate.md +++ b/docs/docs/subscriptions/reactivate.md @@ -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. diff --git a/docs/docs/subscriptions/remove-seats.md b/docs/docs/subscriptions/remove-seats.md index 1cd9fcb..e35db4a 100644 --- a/docs/docs/subscriptions/remove-seats.md +++ b/docs/docs/subscriptions/remove-seats.md @@ -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`. diff --git a/docs/docs/subscriptions/update.md b/docs/docs/subscriptions/update.md index 0bdb044..449de93 100644 --- a/docs/docs/subscriptions/update.md +++ b/docs/docs/subscriptions/update.md @@ -2,7 +2,7 @@ sidebar_position: 13 --- -# Update Subscription +# Update subscription Update properties on a subscription. From 7506946fcc1f5d649acc4b7f356395e65409f4d0 Mon Sep 17 00:00:00 2001 From: Perry George Date: Wed, 21 May 2025 16:31:35 +0100 Subject: [PATCH 2/2] docs: updated text on get user plans --- docs/docs/subscriptions/add-seats.md | 2 +- docs/docs/subscriptions/get-user-plans.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/subscriptions/add-seats.md b/docs/docs/subscriptions/add-seats.md index 9e18820..b69ff6f 100644 --- a/docs/docs/subscriptions/add-seats.md +++ b/docs/docs/subscriptions/add-seats.md @@ -4,7 +4,7 @@ sidebar_position: 11 # Add seats -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. +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 diff --git a/docs/docs/subscriptions/get-user-plans.md b/docs/docs/subscriptions/get-user-plans.md index 1f76ab4..9b6225b 100644 --- a/docs/docs/subscriptions/get-user-plans.md +++ b/docs/docs/subscriptions/get-user-plans.md @@ -4,7 +4,7 @@ sidebar_position: 6 # Get switchable plans -Returns the available plans the customer on the subscription can change to. +Returns the available plans the customer on the subscription can switch to. ## Code Sample