List subscription products¶
List subscription products, monthly Credit prices, and product entitlements.
GET https://billing.moi.matrixorigin.cn/api/v1/billing/accounts/$ACCOUNT_ID/subscription-products
Before you begin¶
Prepare a valid personal access token for the account owner.
Call List current accounts to obtain the target account’s ID.
Request example¶
Replace $MOI_PERSONAL_ACCESS_TOKEN and $ACCOUNT_ID in the example with your personal access token and the selected account’s ID.
curl -X GET \
"https://billing.moi.matrixorigin.cn/api/v1/billing/accounts/$ACCOUNT_ID/subscription-products" \
-H "X-API-Key: $MOI_PERSONAL_ACCESS_TOKEN"
Path parameters¶
Parameter |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes |
Target account ID from |
Successful response¶
Returns HTTP 200 with the available subscription products, prices, and entitlements.
{
"items": [
{
"product_code": "enterprise_sso",
"plan_code": "enterprise_identity",
"name": "Enterprise Identity",
"description": "SSO/SAML integration for enterprise identity management.",
"product_price_id": "price_example",
"price_credit_per_month": "300.000000000000",
"currency": "CREDIT",
"status": "active",
"entitlement_version": 1,
"entitlements": {
"enterprise_sso": true,
"support.priority": "priority"
},
"sort_order": 30
}
],
"total": 1
}
Field |
Type |
Description |
|---|---|---|
|
array of object |
Records returned by this request. |
|
string |
Subscription product code. |
|
string |
Plan code; may be omitted. |
|
string |
Product name. |
|
string |
Product description; may be omitted. |
|
string |
Product price ID. |
|
string |
Monthly subscription price in Credit, as a decimal string. |
|
string |
Price unit, |
|
string |
Product status. |
|
integer |
Entitlement version. |
|
object |
Product entitlements, with keys depending on the product. |
|
boolean |
Enterprise identity integration entitlement, when applicable. |
|
string |
Support priority. The period is part of the key. |
|
boolean |
Private model deployment entitlement, when applicable. Periods are part of the key. |
|
integer |
Product display sort order. |
|
integer |
Total number of returned records. |
In field paths, [] denotes each array item. For example, items[].product_code refers to the corresponding field in each item.
Error response¶
Missing authentication returns HTTP 401; provide a valid personal access token.
{
"code": "unauthenticated",
"message": "missing bearer token",
"error": "missing bearer token"
}
Field |
Type |
Description |
|---|---|---|
|
string |
Error code. |
|
string |
Error message. |
|
string |
Compatibility error message, with the same content as message. |