From 5a16496ad8723d35427155af78accb45314d97f7 Mon Sep 17 00:00:00 2001 From: Derric Gilling Date: Thu, 2 May 2024 17:27:10 -0400 Subject: [PATCH] Update Description for subscription_id --- source/includes/collector-api/_actions-api.md | 4 ++-- source/includes/collector-api/_events-api.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/includes/collector-api/_actions-api.md b/source/includes/collector-api/_actions-api.md index d90f70c..de24134 100644 --- a/source/includes/collector-api/_actions-api.md +++ b/source/includes/collector-api/_actions-api.md @@ -86,7 +86,7 @@ action_name | string | __true__ | A recognizable name such as Clicked Sign Up session_token | string | false | The customer's current session token as a string. user_id | string | false | Associate this API call to a [user](#users). Typically, a real person. company_id | string | false | Associate this API call to a [company](#companies) (Required for metered billing). -subscription_id | string | false | Associate this API call to a specific [subscription](#subscriptions) of a company. Not needed unless same company can have multiple subscriptions to the same plan. +subscription_id | string | false | Associate this API call to a specific [subscription](#subscriptions) of a company. Not needed unless same company can have multiple subscriptions to the same plan. When set, usage will be reported to only this subscription. metadata | object | false | An object containing any custom event metadata you want to store with this event. request |object | __true__ | The object containing the action's request context.

time

|string(date-time) | false | Timestamp for the action in ISO 8601 format. Set by server automatically if not set. @@ -200,7 +200,7 @@ action_name | string | __true__ | A recognizable name such as Clicked Sign Up session_token | string | false | The customer's current session token as a string. user_id | string | false | Associate this API call to a [user](#users). Typically, a real person. company_id | string | false | Associate this API call to a [company](#companies) (Required for metered billing). -subscription_id | string | false | Associate this API call to a specific [subscription](#subscriptions) of a company. Not needed unless same company can have multiple subscriptions to the same plan. +subscription_id | string | false | Associate this API call to a specific [subscription](#subscriptions) of a company. Not needed unless same company can have multiple subscriptions to the same plan. When set, usage will be reported to only this subscription. metadata | object | false | An object containing any custom event metadata you want to store with this event. request |object | __true__ | The object containing the action's request context.

time

|string(date-time) | false | Timestamp for the action in ISO 8601 format. Set by server automatically if not set. diff --git a/source/includes/collector-api/_events-api.md b/source/includes/collector-api/_events-api.md index fb454f7..38b7b8d 100644 --- a/source/includes/collector-api/_events-api.md +++ b/source/includes/collector-api/_events-api.md @@ -661,7 +661,7 @@ transaction_id | string | false | A random 36 char UUID for this event. If set, session_token | string | false | Set the API key/session token used for this API call. Moesif will auto-detect API sessions if not set. user_id | string | false | Associate this API call to a [user](#users). Typically, a real person. company_id | string | false | Associate this API call to a [company](#companies) (Required for metered billing). -subscription_id | string | false | Associate this API call to a specific [subscription](#subscriptions) of a company. Not needed unless same company can have multiple subscriptions to the same plan. +subscription_id | string | false | Associate this API call to a specific [subscription](#subscriptions) of a company. Not needed unless same company can have multiple subscriptions to the same plan. When set, usage will be reported to only this subscription. direction | string | false | The direction of this API call which can be _Incoming_ or _Outgoing_. metadata | object | false | An object containing any custom event metadata you want to store with this event. @@ -1238,6 +1238,6 @@ transaction_id | string | false | A random 36 char UUID for this event. If set, session_token | string | false | Set the API key/session token used for this API call. Moesif will auto-detect API sessions if not set. user_id | string | false | Associate this API call to a [user](#users). Typically, a real person. company_id | string | false | Associate this API call to a [company](#companies) (Required for metered billing). -subscription_id | string | false | Associate this API call to a specific [subscription](#subscriptions) of a company. Not needed unless same company can have multiple subscriptions to the same plan. +subscription_id | string | false | Associate this API call to a specific [subscription](#subscriptions) of a company. Not needed unless same company can have multiple subscriptions to the same plan. When set, usage will be reported to only this subscription. direction | string | false | The direction of this API call which can be _Incoming_ or _Outgoing_. metadata | object | false | An object containing any custom event metadata you want to store with this event.