Get subscription state

GET 
https://euwest.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid/states/:state_uuid

Get subscription state

Request

Path Parameters

subscription_uuid UUIDrequired

The unique identifier of the subscription.

state_uuid UUIDrequired

The unique identifier of the subscription state.

Responses

200

Success. A subscription state is returned.

application/json

Schema

Schema

data SubscriptionState

id UUID (string)

The unique identifier.

type SubscriptionStateType (string)required

Possible values: [subscription_state]

This represents the type of resource object being returned. Always subscription_state.

attributes SubscriptionStateAttributesrequired

action SubscriptionStateAction (string)required

Possible values: [cancel, pause, resume, pending]

The subscription lifecycle is the states that a subscription can go through when a customer subscribes to a service or a product.

A subscription can have the following states; canceled, paused, or resumed.

See Managing the subscription lifecycle.

meta StateMetarequired

created_at stringrequired

The date and time a resource was created.

Example (from schema)

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "subscription_state",
    "attributes": {
      "action": "cancel"
    },
    "meta": {
      "created_at": "2017-01-10T11:41:19.244842Z"
    }
  }
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors Error[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

missing-name

{
  "errors": [
    {
      "title": "Validation Error",
      "status": "400",
      "detail": "data.attributes.name: \"name\" is required"
    }
  ]
}

404

Not found. The requested entity does not exist.

application/json

Schema

Schema

errors Error[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

not-found

{
  "errors": [
    {
      "title": "Not Found",
      "status": "404",
      "detail": "No plan found"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500"
    }
  ]
}

Authorization: http

name: BearerTokentype: httpscheme: bearer

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://euwest.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid/states/:state_uuid' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://euwest.api.elasticpath.com/v2

Auth

Bearer Token

Parameters

subscription_uuid — pathrequired

state_uuid — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!