Sign in

v1

latestOpenAPI 3.0.12026-07-24110189356.6 KB
subscription

Gets the status of the subscription create/delete process.

Returns the configuration of the subscription associated with the HRN.

get/subscriptions/status/{statusToken}

Path parameters

statusTokenstring required

Status token from the create/delete subscription response.

Query parameters

billingTagstring

The billingTag parameter is an optional free-form tag that you can use to group billing records together. If supplied, it must be between 4 - 16 characters, contain only alpha/numeric ASCII characters [A-Za-z0-9]. Grouping billing records by billing tag will be available in future releases.

Response

OK

status'pending' | 'failed' | 'active' | 'deleted' required

Status:

  • pending - Operation is in progress.
  • failed - The operation failed.
  • active - Subscription was successfully created and is active.
  • deleted - Subscription was successfully deleted.
subscriptionHrnstring

The HERE Resource Name (HRN) of the newly created subscription.

Example response

{
  "subscriptionHrn": "hrn:here:data-subscription::olp-here:my-subscription-7d93563980d94f1b"
}