Skip to content

update items to subscriptions #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 2, 2024
Merged

update items to subscriptions #72

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions source/includes/collector-api/_subscriptions-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.