GET api/subscriptions

Retrieves a list of subscriptions for the currently logged-in customer.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A list of subscriptions.

Collection of SubscriptionQuery

Name	Type	Additional information
Id	integer	None.
Suspended	boolean	None.
BankInformationId	integer	None.
CategoryId	integer	None.
CommitmentEndDate	date	None.
CustomerId	integer	None.
EndDate	date	None.
PackageProvisioningCode	integer	None.
PayerId	integer	None.
PaymentInformationId	integer	None.
PhoneNumber	string	None.
PricePlanId	integer	None.
ProductName	string	None.
ProductSalesText	string	None.
ShippingId	integer	None.
StartDate	date	None.
SubscriptionStateId	integer	None.
SubscriptionTypeId	integer	None.
WholeSalesPartnerId	integer	None.
WholeSalesPartnerName	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Suspended": true,
    "BankInformationId": 1,
    "CategoryId": 3,
    "CommitmentEndDate": "2025-12-06T02:21:10.8980894+01:00",
    "CustomerId": 4,
    "EndDate": "2025-12-06T02:21:10.8980894+01:00",
    "PackageProvisioningCode": 5,
    "PayerId": 1,
    "PaymentInformationId": 1,
    "PhoneNumber": "sample string 6",
    "PricePlanId": 7,
    "ProductName": "sample string 8",
    "ProductSalesText": "sample string 9",
    "ShippingId": 1,
    "StartDate": "2025-12-06T02:21:10.8980894+01:00",
    "SubscriptionStateId": 11,
    "SubscriptionTypeId": 1,
    "WholeSalesPartnerId": 12,
    "WholeSalesPartnerName": "sample string 13"
  },
  {
    "Id": 1,
    "Suspended": true,
    "BankInformationId": 1,
    "CategoryId": 3,
    "CommitmentEndDate": "2025-12-06T02:21:10.8980894+01:00",
    "CustomerId": 4,
    "EndDate": "2025-12-06T02:21:10.8980894+01:00",
    "PackageProvisioningCode": 5,
    "PayerId": 1,
    "PaymentInformationId": 1,
    "PhoneNumber": "sample string 6",
    "PricePlanId": 7,
    "ProductName": "sample string 8",
    "ProductSalesText": "sample string 9",
    "ShippingId": 1,
    "StartDate": "2025-12-06T02:21:10.8980894+01:00",
    "SubscriptionStateId": 11,
    "SubscriptionTypeId": 1,
    "WholeSalesPartnerId": 12,
    "WholeSalesPartnerName": "sample string 13"
  }
]

text/html

Sample:

[{"Id":1,"Suspended":true,"BankInformationId":1,"CategoryId":3,"CommitmentEndDate":"2025-12-06T02:21:10.8980894+01:00","CustomerId":4,"EndDate":"2025-12-06T02:21:10.8980894+01:00","PackageProvisioningCode":5,"PayerId":1,"PaymentInformationId":1,"PhoneNumber":"sample string 6","PricePlanId":7,"ProductName":"sample string 8","ProductSalesText":"sample string 9","ShippingId":1,"StartDate":"2025-12-06T02:21:10.8980894+01:00","SubscriptionStateId":11,"SubscriptionTypeId":1,"WholeSalesPartnerId":12,"WholeSalesPartnerName":"sample string 13"},{"Id":1,"Suspended":true,"BankInformationId":1,"CategoryId":3,"CommitmentEndDate":"2025-12-06T02:21:10.8980894+01:00","CustomerId":4,"EndDate":"2025-12-06T02:21:10.8980894+01:00","PackageProvisioningCode":5,"PayerId":1,"PaymentInformationId":1,"PhoneNumber":"sample string 6","PricePlanId":7,"ProductName":"sample string 8","ProductSalesText":"sample string 9","ShippingId":1,"StartDate":"2025-12-06T02:21:10.8980894+01:00","SubscriptionStateId":11,"SubscriptionTypeId":1,"WholeSalesPartnerId":12,"WholeSalesPartnerName":"sample string 13"}]

application/xml, text/xml

Sample:

<ArrayOfSubscriptionQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <SubscriptionQuery>
    <BankInformationId>1</BankInformationId>
    <CategoryId>3</CategoryId>
    <CommitmentEndDate>2025-12-06T02:21:10.8980894+01:00</CommitmentEndDate>
    <CustomerId>4</CustomerId>
    <EndDate>2025-12-06T02:21:10.8980894+01:00</EndDate>
    <PackageProvisioningCode>5</PackageProvisioningCode>
    <PayerId>1</PayerId>
    <PaymentInformationId>1</PaymentInformationId>
    <PhoneNumber>sample string 6</PhoneNumber>
    <PricePlanId>7</PricePlanId>
    <ProductName>sample string 8</ProductName>
    <ProductSalesText>sample string 9</ProductSalesText>
    <ShippingId>1</ShippingId>
    <StartDate>2025-12-06T02:21:10.8980894+01:00</StartDate>
    <SubscriptionStateId>11</SubscriptionStateId>
    <SubscriptionTypeId>1</SubscriptionTypeId>
    <WholeSalesPartnerId>12</WholeSalesPartnerId>
    <WholeSalesPartnerName>sample string 13</WholeSalesPartnerName>
    <Id>1</Id>
    <Suspended>true</Suspended>
  </SubscriptionQuery>
  <SubscriptionQuery>
    <BankInformationId>1</BankInformationId>
    <CategoryId>3</CategoryId>
    <CommitmentEndDate>2025-12-06T02:21:10.8980894+01:00</CommitmentEndDate>
    <CustomerId>4</CustomerId>
    <EndDate>2025-12-06T02:21:10.8980894+01:00</EndDate>
    <PackageProvisioningCode>5</PackageProvisioningCode>
    <PayerId>1</PayerId>
    <PaymentInformationId>1</PaymentInformationId>
    <PhoneNumber>sample string 6</PhoneNumber>
    <PricePlanId>7</PricePlanId>
    <ProductName>sample string 8</ProductName>
    <ProductSalesText>sample string 9</ProductSalesText>
    <ShippingId>1</ShippingId>
    <StartDate>2025-12-06T02:21:10.8980894+01:00</StartDate>
    <SubscriptionStateId>11</SubscriptionStateId>
    <SubscriptionTypeId>1</SubscriptionTypeId>
    <WholeSalesPartnerId>12</WholeSalesPartnerId>
    <WholeSalesPartnerName>sample string 13</WholeSalesPartnerName>
    <Id>1</Id>
    <Suspended>true</Suspended>
  </SubscriptionQuery>
</ArrayOfSubscriptionQuery>