Query subscription products and records¶
Inspect available subscription products, prices, and entitlements, and view the periods, status, and entitlements of existing account subscriptions. This task does not purchase or cancel subscriptions.
Prerequisites¶
Prepare a valid personal access token for the user who owns the billing account. Follow Query accounts and billing settings to obtain the target account ID. For service URLs and authentication, see Service URLs and authentication.
Call sequence¶
To inspect available products, list subscription products and review monthly Credit prices and entitlements.
List the account’s subscriptions to inspect existing subscriptions, periods, prices, and entitlements.
When inspecting an existing subscription, use the information in its subscription record rather than substituting the product catalog.
API operations¶
Task |
API operation |
When to use or what to verify |
|---|---|---|
Inspect available products |
Compare monthly Credit prices and product entitlements. |
|
Inspect existing subscriptions |
Check account subscription periods, status, and entitlements. |
Confirm the result¶
Use List subscriptions to inspect existing account subscriptions. The product catalog describes available products, not what the account has subscribed to. The subscription list is empty when the account has no subscriptions.
Limitations and notes¶
The subscription list returns up to 1,000 of the most recently created records without pagination. The total is the number of records returned in this response.