Filter results by organization identifier.
List subscriptions
GET/admin/v1/subscriptionsLists subscriptions.
query parameters
Returns
The list of subscriptions.
The billing connection.
The delegated connection.
The Amazon Cognito connection data.
The Auth0 connection data.
The Google Cloud Identity Platform (Firebase Auth) connection.
The Postmark configuration data.
The from email address.
The Postmark account must be allowed to send from this email address.
The email address (e.g.
[email protected]).The reply to email address.
The email address (e.g.
[email protected]).The webhooks configuration data.
The plan.
The items associated with plan.
The product associated with the item.
The connected products.
The basic view of the connection.
The delegated connection.
The Amazon Cognito connection data.
The Auth0 connection data.
The Google Cloud Identity Platform (Firebase Auth) connection.
The Postmark configuration data.
The from email address.
The Postmark account must be allowed to send from this email address.
The email address (e.g.
[email protected]).The reply to email address.
The email address (e.g.
[email protected]).The webhooks configuration data.
The price associated with them item.
The connection.
The delegated connection.
The Amazon Cognito connection data.
The Auth0 connection data.
The Google Cloud Identity Platform (Firebase Auth) connection.
The Postmark configuration data.
The from email address.
The Postmark account must be allowed to send from this email address.
The email address (e.g.
[email protected]).The reply to email address.
The email address (e.g.
[email protected]).The webhooks configuration data.
The product associated with the price.
The connected products.
The basic view of the connection.
The delegated connection.
The Amazon Cognito connection data.
The Auth0 connection data.
The Google Cloud Identity Platform (Firebase Auth) connection.
The Postmark configuration data.
The from email address.
The Postmark account must be allowed to send from this email address.
The email address (e.g.
[email protected]).The reply to email address.
The email address (e.g.
[email protected]).The webhooks configuration data.
The price is fixed per quantity.
The price is dependent on the quantity.
The subscription items.
The item product.
The connected products.
The basic view of the connection.
The delegated connection.
The Amazon Cognito connection data.
The Auth0 connection data.
The Google Cloud Identity Platform (Firebase Auth) connection.
The Postmark configuration data.
The from email address.
The Postmark account must be allowed to send from this email address.
The email address (e.g.
[email protected]).The reply to email address.
The email address (e.g.
[email protected]).The webhooks configuration data.
The item price.
The connection.
The delegated connection.
The Amazon Cognito connection data.
The Auth0 connection data.
The Google Cloud Identity Platform (Firebase Auth) connection.
The Postmark configuration data.
The from email address.
The Postmark account must be allowed to send from this email address.
The email address (e.g.
[email protected]).The reply to email address.
The email address (e.g.
[email protected]).The webhooks configuration data.
The product associated with the price.
The connected products.
The basic view of the connection.
The delegated connection.
The Amazon Cognito connection data.
The Auth0 connection data.
The Google Cloud Identity Platform (Firebase Auth) connection.
The Postmark configuration data.
The from email address.
The Postmark account must be allowed to send from this email address.
The email address (e.g.
[email protected]).The reply to email address.
The email address (e.g.
[email protected]).The webhooks configuration data.
The price is fixed per quantity.
The price is dependent on the quantity.
The seat information.
The seat product.
The connected products.
The basic view of the connection.
The delegated connection.
The Amazon Cognito connection data.
The Auth0 connection data.
The Google Cloud Identity Platform (Firebase Auth) connection.
The Postmark configuration data.
The from email address.
The Postmark account must be allowed to send from this email address.
The email address (e.g.
[email protected]).The reply to email address.
The email address (e.g.
[email protected]).The webhooks configuration data.
The payment method.
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
Card payment method (e.g. Visa credit card).
The trial information for the subscription.
The organization owner of the subscription.
The ID field of this object must be populated if if user isn't specified.
The connected accounts.
The tenant connection.
The delegated connection.
The Amazon Cognito connection data.
The Auth0 connection data.
The Google Cloud Identity Platform (Firebase Auth) connection.
The Postmark configuration data.
The from email address.
The Postmark account must be allowed to send from this email address.
The email address (e.g.
[email protected]).The reply to email address.
The email address (e.g.
[email protected]).The webhooks configuration data.
The payment methods for connections that support it.
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
Card payment method (e.g. Visa credit card).
The organization's default active subscription.
The plan.
The user owner of the subscription.
The ID field of this object must be populated if if organization isn't specified.
The connected accounts.
The tenant connection.
The delegated connection.
The Amazon Cognito connection data.
The Auth0 connection data.
The Google Cloud Identity Platform (Firebase Auth) connection.
The Postmark configuration data.
The from email address.
The Postmark account must be allowed to send from this email address.
The email address (e.g.
[email protected]).The reply to email address.
The email address (e.g.
[email protected]).The webhooks configuration data.
The payment methods for connections that support it.
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
Card payment method (e.g. Visa credit card).
The user's default active individual subscription.
See memberships for organization subscription and seat information.
The plan.
The user's organization memberships.
The organization.
The connected accounts.
The tenant connection.
The delegated connection.
The Amazon Cognito connection data.
The Auth0 connection data.
The Google Cloud Identity Platform (Firebase Auth) connection.
The Postmark configuration data.
The from email address.
The Postmark account must be allowed to send from this email address.
The email address (e.g.
[email protected]).The reply to email address.
The email address (e.g.
[email protected]).The webhooks configuration data.
The payment methods for connections that support it.
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
Card payment method (e.g. Visa credit card).
The organization's default active subscription.
The plan.
The user's role within the organization.
The seat associated with the membership.
This will be absent if there is no active default subscription for the organization or the user has not been assigned a seat.
curl https://api.userhub.com/admin/v1/subscriptions?organizationId=org_28seyVGVL1got6 \
-H "Authorization: Bearer $USERHUB_ADMIN_KEY"const res = await adminApi.subscriptions.list({
organizationId: "org_28seyVGVL1got6",
});
res, err := adminApi.Subscriptions().List(
context.Background(),
&adminapi.SubscriptionListInput{
OrganizationId: "org_28seyVGVL1got6",
},
)
$res = $adminApi->subscriptions->list(
organizationId: 'org_28seyVGVL1got6',
);
res = admin_api.subscriptions.list(
organization_id="org_28seyVGVL1got6",
)
Response bodyJSON
{
"subscriptions": [
{
"id": "sub_UBUqH64iKRBdCD",
"state": "ACTIVE",
"connection": {
"id": "conn_4HdRKnTvPmmjYK",
"displayName": "Stripe",
"state": "ACTIVE",
"type": "STRIPE",
"delegate": null,
"providers": [],
"createTime": "2024-11-15T13:00:00Z",
"updateTime": "2024-11-15T13:00:00Z"
},
"externalId": "sub_1PGhMaI1Zx1mDKAzigGeR4s9",
"plan": {
"id": "pg_2wnGzPMSrDBYK5:ukfHizos:monthly:usd",
"displayName": "Pro",
"description": "The pro plan.",
"currencyCode": "USD",
"billingInterval": {
"quantity": 1,
"unit": "MONTH"
},
"tags": [
"default"
],
"items": []
},
"currencyCode": "USD",
"items": [],
"seats": [
{
"product": {
"id": "pd_3fNK5BXs9C1Fdc",
"uniqueId": "pro-seat",
"displayName": "Pro seat",
"description": "The pro seat.",
"committed": true,
"archived": false,
"productConnections": [],
"createTime": "2024-11-15T13:00:00Z",
"updateTime": "2024-11-15T13:00:00Z"
},
"currentPeriodQuantity": 0,
"assignedQuantity": 0,
"unassignedQuantity": 0,
"totalQuantity": 0
}
],
"paymentMethod": null,
"anchorTime": "2024-11-15T13:00:00Z",
"startTime": "2024-11-15T13:00:00Z",
"endTime": null,
"trial": null,
"currentPeriod": {
"startTime": "2024-11-15T13:00:00Z",
"endTime": "2024-12-15T13:00:00Z"
},
"organization": {
"id": "org_28seyVGVL1got6",
"state": "ACTIVE",
"displayName": "Acme Inc",
"email": "[email protected]",
"emailVerified": true,
"imageUrl": "https://example.com/acme.jpg",
"address": null,
"accountConnections": [],
"subscription": null,
"signupTime": "2024-11-15T13:00:00Z",
"memberCount": 0,
"createTime": "2024-11-15T13:00:00Z",
"updateTime": "2024-11-15T13:00:00Z"
},
"user": null,
"default": true,
"pullTime": "2024-11-15T13:00:00Z",
"pushTime": "2024-11-15T13:00:00Z",
"createTime": "2024-11-15T13:00:00Z",
"updateTime": "2024-11-15T13:00:00Z"
}
],
"nextPageToken": ""
}