GET Subscriptions?for_guid={for_guid}&appid={appid}&sg={sg}&hash={hash}&token={token}&active_only={active_only}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| for_guid | string |
Required |
|
| appid | string |
Required |
|
| sg | string |
Required |
|
| hash | string |
Required |
|
| token | string |
Required |
|
| active_only | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
BaseGridOfSubscriptions| Name | Description | Type | Additional information |
|---|---|---|---|
| page | integer |
None. |
|
| records | integer |
None. |
|
| total | integer |
None. |
|
| the_list | Collection of Subscriptions |
None. |
Response Formats
application/json, text/json
Sample:
{
"page": 1,
"records": 2,
"total": 3,
"the_list": [
null,
{
"appid": "sample string 1",
"name": "sample string 2",
"description": "sample string 3",
"for_guid": "sample string 4",
"for_guid_type": "sample string 5",
"subscription_type": "sample string 6",
"start_date": "2026-05-11T04:35:26.6825005+00:00",
"end_date": "2026-05-11T04:35:26.6825005+00:00",
"created_date": "2026-05-11T04:35:26.6825005+00:00",
"active": true,
"supplemental_data_rds_type": "sample string 7",
"supplemental_data_rds_id": "sample string 8",
"payment_processing_rds_type": "sample string 9",
"payment_processing_rds_id": "sample string 10",
"payment_guid": "sample string 11",
"erp_fullfillment_id": "sample string 12",
"subscription_history": [
null,
{
"change_type": "sample string 1",
"for_guid": "sample string 2",
"for_guid_type": "sample string 3",
"user_guid": "sample string 4",
"user_guid_type": "sample string 5",
"description": "sample string 6",
"as_of_date": "2026-05-11T04:35:26.6981068+00:00",
"guid": "000000000000000000000000",
"guid_datetime": "1970-01-01T00:00:00Z"
}
],
"subscription_objects": [
null,
{
"for_guid": "sample string 1",
"for_guid_type": "sample string 2",
"as_of_date": "2026-05-11T04:35:26.6981068+00:00",
"guid": "000000000000000000000000",
"guid_datetime": "1970-01-01T00:00:00Z"
}
],
"subscription_payments": [
null,
{
"subscription_amount": null,
"tax_amount": null,
"payment_guid": "sample string 1",
"payment_type": "sample string 2",
"payment_for_guid": "sample string 3",
"comments": "sample string 4",
"as_of_date": "2026-05-11T04:35:26.6981068+00:00",
"guid": "000000000000000000000000",
"guid_datetime": "1970-01-01T00:00:00Z"
}
],
"guid": "000000000000000000000000",
"guid_datetime": "1970-01-01T00:00:00Z"
}
]
}
application/xml, text/xml
Sample:
<BaseGridOfSubscriptionsXD55xrjw xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/productious_models">
<page>1</page>
<records>2</records>
<the_list>
<Subscriptions i:nil="true" />
<Subscriptions>
<guid>000000000000000000000000</guid>
<id xmlns:d4p1="http://schemas.datacontract.org/2004/07/MongoDB.Bson">
<d4p1:_a>0</d4p1:_a>
<d4p1:_b>0</d4p1:_b>
<d4p1:_c>0</d4p1:_c>
</id>
<active>true</active>
<appid>sample string 1</appid>
<created_date>2026-05-11T04:35:26.6825005+00:00</created_date>
<description>sample string 3</description>
<end_date>2026-05-11T04:35:26.6825005+00:00</end_date>
<erp_fullfillment_id>sample string 12</erp_fullfillment_id>
<for_guid>sample string 4</for_guid>
<for_guid_type>sample string 5</for_guid_type>
<name>sample string 2</name>
<payment_guid>sample string 11</payment_guid>
<payment_processing_rds_id>sample string 10</payment_processing_rds_id>
<payment_processing_rds_type>sample string 9</payment_processing_rds_type>
<start_date>2026-05-11T04:35:26.6825005+00:00</start_date>
<subscription_history>
<SubscriptionHistory i:nil="true" />
<SubscriptionHistory>
<guid>000000000000000000000000</guid>
<id xmlns:d6p1="http://schemas.datacontract.org/2004/07/MongoDB.Bson">
<d6p1:_a>0</d6p1:_a>
<d6p1:_b>0</d6p1:_b>
<d6p1:_c>0</d6p1:_c>
</id>
<as_of_date>2026-05-11T04:35:26.6981068+00:00</as_of_date>
<change_type>sample string 1</change_type>
<description>sample string 6</description>
<for_guid>sample string 2</for_guid>
<for_guid_type>sample string 3</for_guid_type>
<user_guid>sample string 4</user_guid>
<user_guid_type>sample string 5</user_guid_type>
</SubscriptionHistory>
</subscription_history>
<subscription_objects>
<SubscriptionObjects i:nil="true" />
<SubscriptionObjects>
<guid>000000000000000000000000</guid>
<id xmlns:d6p1="http://schemas.datacontract.org/2004/07/MongoDB.Bson">
<d6p1:_a>0</d6p1:_a>
<d6p1:_b>0</d6p1:_b>
<d6p1:_c>0</d6p1:_c>
</id>
<as_of_date>2026-05-11T04:35:26.6981068+00:00</as_of_date>
<for_guid>sample string 1</for_guid>
<for_guid_type>sample string 2</for_guid_type>
</SubscriptionObjects>
</subscription_objects>
<subscription_payments>
<SubscriptionPayment i:nil="true" />
<SubscriptionPayment>
<guid>000000000000000000000000</guid>
<id xmlns:d6p1="http://schemas.datacontract.org/2004/07/MongoDB.Bson">
<d6p1:_a>0</d6p1:_a>
<d6p1:_b>0</d6p1:_b>
<d6p1:_c>0</d6p1:_c>
</id>
<as_of_date>2026-05-11T04:35:26.6981068+00:00</as_of_date>
<comments>sample string 4</comments>
<payment_for_guid>sample string 3</payment_for_guid>
<payment_guid>sample string 1</payment_guid>
<payment_type>sample string 2</payment_type>
<subscription_amount i:nil="true" />
<tax_amount i:nil="true" />
</SubscriptionPayment>
</subscription_payments>
<subscription_type>sample string 6</subscription_type>
<supplemental_data_rds_id>sample string 8</supplemental_data_rds_id>
<supplemental_data_rds_type>sample string 7</supplemental_data_rds_type>
</Subscriptions>
</the_list>
<total>3</total>
</BaseGridOfSubscriptionsXD55xrjw>