Get All Subscriptions
Returns a list of all the subscriptions created by your Salable organization.
Code Sample
import { Salable } from '@salable/node-sdk';
const salable = new Salable('{{API_KEY}}', 'v2');
const subscription = await salable.subscriptions.getAll();
Parameters
options
Type: GetSubscriptionOptions
Option | Type | Description | Required |
---|---|---|---|
status | string | The status of the subscription, e.g. "ACTIVE" "CANCELED" | ❌ |
string | The email of who purchased the subscription | ❌ | |
cursor | string | Cursor value, used for pagination | ❌ |
take | number | The amount of subscriptions to fetch. Default: 20 | ❌ |
productUuid | string | Filter subscriptions by product | ❌ |
planUuid | string | Filter subscriptions by plan | ❌ |
sort | string | Sorts by expiryDate field. Default ('asc' ). Enum: 'asc' | 'desc' | ❌ |
Return Type
For more information about this request see our API documentation on Subscription Object