Required role: | Admin |
All Verbs | /query/subscriptions |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
CustomerId | form | int | No | |
form | string | No | ||
SkuId | form | int | No | |
SkuName | form | string | No | |
SkuType | form | SkuType | No | |
Code | form | string | No | |
Quantity | form | int | No | |
SupportQuantity | form | int | No | |
Total | form | int | No | |
IsPlan | form | bool | No | |
IsRenewal | form | bool | No | |
SubscriptionDurationDays | form | int | No | |
RenewalDate | form | DateTime? | No | |
LicenseRef | form | string | No | |
LicenseName | form | string | No | |
LicenseAddress | form | string | No | |
LicenseType | form | LicenseType | No | |
ExpiryDate | form | DateTime | No | |
LicenseKey | form | LicenseKey | No | |
LicenseKeyText | form | string | No | |
CreatedDate | form | DateTime | No | |
ModifiedDate | form | DateTime | No | |
CancelledDate | form | DateTime? | No | |
StripeSubscriptionId | form | string | No | |
EmailId | form | int? | No | |
EmailRenewalId | form | int? | No | |
EmailExpiredId | form | int? | No | |
RenewalSubscriptionId | form | int? | No | |
ExternalRef | form | string | No | |
Notes | form | string | No | |
Error | form | string | No |
Product | |
PerDev | |
PerCore | |
Site | |
Support | |
Training | |
Register | |
Payment |
Free | |
FreeIndividual | |
FreeOpenSource | |
Indie | |
Business | |
Enterprise | |
TextIndie | |
TextBusiness | |
OrmLiteIndie | |
OrmLiteBusiness | |
RedisIndie | |
RedisBusiness | |
AwsIndie | |
AwsBusiness | |
Trial | |
Site | |
TextSite | |
RedisSite | |
OrmLiteSite |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Ref | form | string | No | |
Name | form | string | No | |
Type | form | LicenseType | No | |
Meta | form | long | No | |
Hash | form | string | No | |
Halg | form | string | No | |
Expiry | form | DateTime | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<Customer> | Yes | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
form | string | No | ||
DisplayName | form | string | No | |
FirstName | form | string | No | |
LastName | form | string | No | |
Company | form | string | No | |
PhoneNumber | form | string | No | |
AddressLine1 | form | string | No | |
AddressLine2 | form | string | No | |
AddressCity | form | string | No | |
AddressZip | form | string | No | |
AddressState | form | string | No | |
AddressCountry | form | string | No | |
StripeCustomerId | form | string | No | |
StripeCouponId | form | string | No | |
Plan | form | string | No | |
CreatedDate | form | DateTime | No | |
IsReferrer | form | bool | No | |
Orders | form | List<Order> | No | |
Subscriptions | form | List<Subscription> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
CustomerId | form | int | No | |
ProductName | form | string | No | |
FirstName | form | string | No | |
LastName | form | string | No | |
form | string | No | ||
Company | form | string | No | |
PhoneNumber | form | string | No | |
AddressLine1 | form | string | No | |
AddressLine2 | form | string | No | |
AddressCity | form | string | No | |
AddressZip | form | string | No | |
AddressState | form | string | No | |
AddressCountry | form | string | No | |
AgreeTerms | form | bool | No | |
Notes | form | string | No | |
Last4 | form | string | No | |
SubTotal | form | int | No | |
CouponId | form | string | No | |
Discount | form | int | No | |
Tax | form | int | No | |
Total | form | int | No | |
ItemQuantity | form | int | No | |
AuthorizedQuantity | form | int? | No | |
SubscriptionId | form | int? | No | |
LicenseRef | form | string | No | |
PaymentId | form | int? | No | |
EmailId | form | int? | No | |
Paid | form | bool | No | |
CreatedDate | form | DateTime | No | |
ModifiedDate | form | DateTime | No | |
ModifiedBy | form | string | No | |
CancelledDate | form | DateTime? | No | |
CancelledReason | form | string | No | |
IpAddress | form | string | No | |
OrderDetails | form | List<OrderDetail> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
OrderId | form | int | No | |
SkuId | form | int | No | |
SkuType | form | SkuType | No | |
Price | form | int | No | |
Description | form | string | No | |
Quantity | form | int | No | |
Total | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /query/subscriptions HTTP/1.1
Host: account.servicestack.net
Accept: application/json
Content-Type: application/json
Content-Length: length
{"skip":0,"take":0,"orderBy":"String","orderByDesc":"String","include":"String","fields":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"offset":0,"total":0,"results":[{"id":0,"customerId":0,"email":"String","skuId":0,"skuName":"String","skuType":"Product","code":"String","quantity":0,"supportQuantity":0,"total":0,"isPlan":false,"isRenewal":false,"subscriptionDurationDays":0,"renewalDate":"\/Date(-62135596800000-0000)\/","licenseRef":"String","licenseName":"String","licenseAddress":"String","licenseType":"Free","expiryDate":"\/Date(-62135596800000-0000)\/","licenseKey":{"ref":"String","name":"String","type":"Free","meta":0,"hash":"String","halg":"String","expiry":"\/Date(-62135596800000-0000)\/"},"licenseKeyText":"String","createdDate":"\/Date(-62135596800000-0000)\/","modifiedDate":"\/Date(-62135596800000-0000)\/","cancelledDate":"\/Date(-62135596800000-0000)\/","stripeSubscriptionId":"String","emailId":0,"emailRenewalId":0,"emailExpiredId":0,"renewalSubscriptionId":0,"externalRef":"String","notes":"String","error":"String"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}