Create or update a subscription.
PUT
/subscriptions/{subscriptionID}
200Description
If an object with the same ID already exists, it will be overwritten.
Roles
At least one of the roles below is required to access this endpoint.
FullAccessSubscriptionAdmin
Parameters
Name | Type | Description | Possible Values | |
---|---|---|---|---|
subscriptionID | Required | string | ID of the subscription. | --- |
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 | --- | --- | --- |
Create or update a subscription.
PUT
/subscriptions/{subscriptionID}
200Description
If an object with the same ID already exists, it will be overwritten.
Roles
At least one of the roles below is required to access this endpoint.
FullAccessSubscriptionAdmin
Parameters
Name | Type | Description | Possible Values | |
---|---|---|---|---|
subscriptionID | Required | string | ID of the subscription. | --- |
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 | --- | --- | --- |