Sitecore API catalog/OrderCloud/Subscription

Subscription

Required for processing subscription orders. When a subscription is due to be processed, an order, line items, and payment will be created. The order and subscription will be sent to the URL specified in this resource.

Operations

Retrieve a subscription integration

Request

Security
OAuth2(Required scopes: FullAccessSubscriptionAdmin)
curl -i -X GET \
  https://api.ordercloud.io/v1/integrations/subscription \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
ApiClientIDstring

ID of the API client that will be used to generate the token passed to your hosted application via subscription integration.

Example:""
HashKeystring, <= 50 characters

Security feature that allows your middleware to verify the digital signature in the request header to ensure you only accept trusted data.

Example:""
ElevatedRolesArray of strings(ApiRole)
Items Enum:"ApiClientAdmin""ApiClientReader""AddressAdmin""AddressReader""AdminAddressAdmin""AdminAddressReader""AdminUserAdmin""AdminUserGroupAdmin""AdminUserGroupReader""AdminUserReader"
Example:
[
  "ApiClientAdmin"
]
Activeboolean
Example:false
NotificationDaysinteger, (int32), >= 1
Example:0
Urlstring
Example:""
xpobject
Example:
{}
CustomAuthHeaderNamestring

The header name that can be passed to your middleware.

Example:""
CustomAuthHeaderValuestring

The header value that can be passed to your middleware.

Example:""
Response
{
  "ApiClientID": "",
  "HashKey": "",
  "ElevatedRoles": [
    "ApiClientAdmin"
  ],
  "Active": false,
  "NotificationDays": 0,
  "Url": "",
  "xp": {},
  "CustomAuthHeaderName": "",
  "CustomAuthHeaderValue": ""
}