Create a new subscription.
POST
/subscriptions
201Description
If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.
Roles
At least one of the roles below is required to access this endpoint.
FullAccessSubscriptionAdmin
Request Body
Property | Type | Format | Max Length | Possible Values | ||
---|---|---|---|---|---|---|
ID | string | --- | 100 characters | --- | ||
Frequency | Required | integer | int32 | --- | --- | |
Interval | Required | string | --- | --- | Days, Weeks, Months | |
NextOrderDate | Required | string | date-time | --- | --- | |
EndDate | string | date-time | --- | --- | ||
Active | boolean | --- | --- | --- | ||
FromCompanyID | string | --- | --- | --- | ||
FromUserID | string | --- | --- | --- | ||
ToCompanyID | string | --- | --- | --- | ||
Payment | object | --- | --- | --- | ||
BillingAddressID | string | --- | --- | --- | ||
ShippingAddressID | string | --- | --- | --- | ||
xp | object | --- | --- | --- |
Response Body
Property | Type | Format | Max Length | Possible Values | ||
---|---|---|---|---|---|---|
ID | string | --- | 100 characters | --- | ||
Frequency | integer | int32 | --- | --- | ||
Interval | string | --- | --- | Days, Weeks, Months | ||
NextOrderDate | string | date-time | --- | --- | ||
LastOrderDate | Read Only | string | date-time | --- | --- | |
NotificationDate | Read Only | string | date-time | --- | --- | |
DateCreated | Read Only | string | date-time | --- | --- | |
EndDate | string | date-time | --- | --- | ||
Active | boolean | --- | --- | --- | ||
FromCompanyID | string | --- | --- | --- | ||
FromUserID | string | --- | --- | --- | ||
ToCompanyID | string | --- | --- | --- | ||
Payment | object | --- | --- | --- | ||
BillingAddressID | string | --- | --- | --- | ||
ShippingAddressID | string | --- | --- | --- | ||
xp | object | --- | --- | --- |