Skip to content

Commit 2760695

Browse files
authored
Merge pull request #72 from Moesif/added-readme-for-items
update items to subscriptions
2 parents b553f03 + d078a47 commit 2760695

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

source/includes/collector-api/_subscriptions-api.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,20 @@ Subscriptions in Moesif are identified via a `subscription_id` and should be a _
7373
|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.|
7474
|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.|
7575
|metadata |object| false | An object containing subscription demographics or other properties you want to store with this profile.|
76+
|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.|
77+
78+
79+
##### items (Subscription Items)
80+
81+
|Name|Type|Required|Description|
82+
|-----------|-----------|-----------|-----------|
83+
|plan_id|string| __true__ | The unique identifier the plan the customer subscribed to.|
84+
|subscription_item_id |string| __false__ | The unique identifier for this item instance if available|
85+
|price_id|string| __false__ | The unique identify for the price the customer subscribed to.|
86+
|unit_of_measure|string|__false__| the unit of measure.|
87+
|created_at|string(date-time)|__false__|When this item is created.|
88+
|metadata |object| false |An object containing additional data|
89+
7690

7791
### Update Subscriptions in Batch
7892

@@ -164,3 +178,4 @@ Subscriptions in Moesif are identified via a `subscription_id` and should be a _
164178
|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.|
165179
|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.|
166180
|metadata |object| false | An object containing subscription demographics or other properties you want to store with this profile.|
181+
|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.

0 commit comments

Comments
 (0)