Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Path Subscribers API

A subscriber is someone who subscribes to your plan or service.

Elastic Path Subscribers API is one of 100 APIs that Elastic Path publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Subscribers. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 23 schemas. It is described by OpenAPI 3.1.0, at version 25.1126.6886238.

Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.

5 operations 2 paths 23 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
25.1126.6886238
Base URL
https://useast.api.elasticpath.com
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Elastic Path Subscribers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken). By default, every request must be authenticated.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Subscribers 5

A subscriber is someone who subscribes to your plan or service.

GET
/v2/subscriptions/subscribers
List subscribers
ListSubscribers 3 params → 200400500
POST
/v2/subscriptions/subscribers
Create a subscriber
CreateSubscriber 1 param body → 201400500
GET
/v2/subscriptions/subscribers/{subscriber_uuid}
Get a subscriber
GetSubscriber 1 param → 200400404500
PUT
/v2/subscriptions/subscribers/{subscriber_uuid}
Update a subscriber
UpdateSubscriber 1 param body → 200400403404409500
DELETE
/v2/subscriptions/subscribers/{subscriber_uuid}
Delete subscriber
DeleteSubscriber 1 param → 204400500

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are Subscriber (4 properties), Error (4 properties), SubscriberAttributes (4 properties), PaymentAuthorityEPPayments (3 properties). Each schema is shown below with its type and property counts.

PaymentAuthorityAuthorizeNet
object
3 properties 1 required
Subscriber
object
4 properties 3 required
SubscriptionSubscriberType
string
SubscriberResponseAttributes
Timestamps
object
2 properties 2 required
Link
Error
object
4 properties 2 required
ErrorResponse
object
1 property 1 required
Links
object
SubscriberMeta
object
3 properties 2 required
PaymentAuthority
object
1 property 1 required
SubscriberAttributes
object
4 properties 3 required
LinkObject
object
3 properties
PaymentAuthorityStripe
object
3 properties 1 required
SubscriberUpdate
object
3 properties 3 required
UUID
string
The unique identifier.
SubscriberUpdateAttributes
object
3 properties
LinkURI
string
PaymentAuthorityEPPayments
object
3 properties 1 required
NullablePaymentAuthority
object
1 property 1 required
OwnerMeta
string
The owner of a resource, either store or organization.
FeatureTag
string
A tag to add to the customer's account when entitled to the feature.
SubscriberCreate
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-subscribers-api-openapi.yml Raw ↑

Other APIs Elastic Path publishes across the network.

Elastic Path GraphQL API
Elastic Path Account Addresses API
Elastic Path Account Authentication Settings API
Elastic Path Account Cart Associations API
Elastic Path Account Management Authentication API
Elastic Path Account Members API
Elastic Path Account Membership API
Elastic Path Account Membership Settings API
Elastic Path Account Tags API
Elastic Path Accounts API
Elastic Path Administrator Latest Releases Catalog API API
Elastic Path Application Keys API