From d078a4788b6368808a3d216349af20b5caacf1dd Mon Sep 17 00:00:00 2001 From: xinghengwang Date: Mon, 2 Dec 2024 11:25:58 -0800 Subject: [PATCH] update items --- .../includes/collector-api/_subscriptions-api.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/source/includes/collector-api/_subscriptions-api.md b/source/includes/collector-api/_subscriptions-api.md index 74ccb9b..a3c3647 100644 --- a/source/includes/collector-api/_subscriptions-api.md +++ b/source/includes/collector-api/_subscriptions-api.md @@ -73,6 +73,20 @@ Subscriptions in Moesif are identified via a `subscription_id` and should be a _ |current_period_end |string(date-time)| false | The end time of the current billing term. This can be yearly, monthly, or other billing term. Required for quota and billing management.| |status |string| __true__ | One of [active, cancelled, paused, trialing, pending, draft, future]. This can be used to drive governance rules that the subscription status in Moesif such as blocking access to cancelled subscriptions.| |metadata |object| false | An object containing subscription demographics or other properties you want to store with this profile.| +|items |object\[\]| false | An array of items, each item represents an plan or price that the customer is subscribed to. See schema for subscription items below.| + + +##### items (Subscription Items) + +|Name|Type|Required|Description| +|-----------|-----------|-----------|-----------| +|plan_id|string| __true__ | The unique identifier the plan the customer subscribed to.| +|subscription_item_id |string| __false__ | The unique identifier for this item instance if available| +|price_id|string| __false__ | The unique identify for the price the customer subscribed to.| +|unit_of_measure|string|__false__| the unit of measure.| +|created_at|string(date-time)|__false__|When this item is created.| +|metadata |object| false |An object containing additional data| + ### Update Subscriptions in Batch @@ -164,3 +178,4 @@ Subscriptions in Moesif are identified via a `subscription_id` and should be a _ |current_period_end |string(date-time)| false | The end time of the current billing term. This can be yearly, monthly, or other billing term. Required for quota and billing management.| |status |string| false | One of [active, cancelled, paused, trialing, pending, draft, future]. This can be used to drive governance rules that the subscription status in Moesif such as blocking access to cancelled subscriptions.| |metadata |object| false | An object containing subscription demographics or other properties you want to store with this profile.| +|items |object\[\]| false | An array of items, each item represents an plan or price that the customer is subscribed to. See schema for items above.