| Required role: | Admin |
| PUT,OPTIONS | /R_Subscriptions/{Id} | ||
|---|---|---|---|
| DELETE,OPTIONS | /R_Subscriptions/{Id} | ||
| POST,OPTIONS | /R_Subscriptions |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountHolderId | body | long | No | |
| RegistrationId | body | long | No | |
| UnitId | body | string | No | |
| SubscriptionStatusTypeId | body | long | No | |
| BrandId | body | long | No | |
| StartDate | body | DateTime | No | |
| PreviousBillDate | body | DateTime? | No | |
| CurrentBillDate | body | DateTime? | No | |
| NextBillDate | body | DateTime? | No | |
| PaidUntil | body | DateTime? | No | |
| NumberOfOccurrences | body | int | No | |
| BillingInterval | body | int | No | |
| BillingIntervalTimeUnitId | body | long | No | |
| TrialOccurrences | body | int? | No | |
| TrialBillingInterval | body | int? | No | |
| TrialBillingIntervalTimeUnitId | body | long? | No | |
| SubscriptionBillingStatusId | body | long? | No | |
| Id | path | long | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountHolderId | body | long | No | |
| RegistrationId | body | long | No | |
| UnitId | body | string | No | |
| SubscriptionStatusTypeId | body | long | No | |
| BrandId | body | long | No | |
| StartDate | body | DateTime | No | |
| PreviousBillDate | body | DateTime? | No | |
| CurrentBillDate | body | DateTime? | No | |
| NextBillDate | body | DateTime? | No | |
| PaidUntil | body | DateTime? | No | |
| NumberOfOccurrences | body | int | No | |
| BillingInterval | body | int | No | |
| BillingIntervalTimeUnitId | body | long | No | |
| TrialOccurrences | body | int? | No | |
| TrialBillingInterval | body | int? | No | |
| TrialBillingIntervalTimeUnitId | body | long? | No | |
| SubscriptionBillingStatusId | body | long? | No | |
| Id | path | long | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /jsv/reply/R_Subscription HTTP/1.1
Host: regapi.pumpalarm.com
Content-Type: text/jsv
Content-Length: length
{
AccountHolderId: 0,
RegistrationId: 0,
UnitId: String,
SubscriptionStatusTypeId: 0,
BrandId: 0,
StartDate: 0001-01-01,
PreviousBillDate: 0001-01-01,
CurrentBillDate: 0001-01-01,
NextBillDate: 0001-01-01,
PaidUntil: 0001-01-01,
NumberOfOccurrences: 0,
BillingInterval: 0,
BillingIntervalTimeUnitId: 0,
TrialOccurrences: 0,
TrialBillingInterval: 0,
TrialBillingIntervalTimeUnitId: 0,
SubscriptionBillingStatusId: 0,
Id: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
AccountHolderId: 0,
RegistrationId: 0,
UnitId: String,
SubscriptionStatusTypeId: 0,
BrandId: 0,
StartDate: 0001-01-01,
PreviousBillDate: 0001-01-01,
CurrentBillDate: 0001-01-01,
NextBillDate: 0001-01-01,
PaidUntil: 0001-01-01,
NumberOfOccurrences: 0,
BillingInterval: 0,
BillingIntervalTimeUnitId: 0,
TrialOccurrences: 0,
TrialBillingInterval: 0,
TrialBillingIntervalTimeUnitId: 0,
SubscriptionBillingStatusId: 0,
Id: 0
}