Skip to main content

Subscription Assignments

A SubscriptionAssignment is an allocation of a single Subscription unit. The way a subscription unit is allocated depends on the Product or Service represented by the Subscription. A common case is that Subscription Units are assigned to Locations. In that case, the SubscriptionAssignment stores the link between a purchased Subscription and the Location it was allocated to.

idstring

The id is a string which is in the form - businessLocationId : productId : activationId

Example: AG-1234:MP-12345:vb99d662-e12f-4r1c-g275-449aa19td438
typestring

Should always be subscriptionAssignment

Possible values: [subscriptionAssignment]

Default value: subscriptionAssignment
attributes object
skustring

The unique identifier of a product, product edition or package. It can be obtained by following this guide. This value is used when placing an order.

productIdstring

The Application ID associated with this subscription

editionIdstring

The Application Edition ID associated with this subscription (if applicable)

statusstring

The status of the Assignment. Both assigned and pendingUnassignment mean it is currently assigned.

Possible values: [assigned, pendingUnassignment, pendingAssignment]

Subscription Assignments
{
  "id": "AG-1234:MP-12345:vb99d662-e12f-4r1c-g275-449aa19td438",
  "type": "subscriptionAssignment",
  "attributes": {
    "sku": "string",
    "productId": "string",
    "editionId": "string",
    "status": "assigned"
  }
}