Create a subscriber

POST 
/subscriptions/subscribers

Create a subscriber

Request

Query Parameters

filter string

application/json

Body

data SubscriberCreaterequired

type SubscriptionSubscriberType (string)required

Possible values: [subscription_subscriber]

attributes SubscriberAttributesrequired

account_id UUID (string)required

The unique identifier.

name stringrequired

Possible values: >= 3 characters and <= 1024 characters

The name of the subscriber.

email emailrequired

Possible values: >= 3 characters and <= 1024 characters

The email of the subscriber.

payment_authority object

oneOf

PaymentAuthorityStripe

type stringrequired

Possible values: [elastic_path_payments_stripe]

The name of the payment gateway facilitating the secure transmission of payment data.

customer_id string

Possible values: >= 3 characters and <= 1024 characters

The unique identifier for a customer.

card_id string

Possible values: >= 3 characters and <= 1024 characters

The unique identifier of the card used to facilitate payment of the subscription. If a card payment fails, you can use the card_id and customer_id attributes to program your front-end implementation to allow your preferred payment service provider to update a subscription with new card details. See Card declines.

PaymentAuthorityAuthorizeNet

type stringrequired

Possible values: [authorize_net]

The name of the payment gateway facilitating the secure transmission of payment data.

payment_profile_id string

Possible values: >= 3 characters and <= 1024 characters

The customer's payment profile id, unique to Authorize.net, used to facilitate payment of the subscription.

customer_profile_id string

Possible values: >= 3 characters and <= 1024 characters

The customer's profile id, unique to Authorize.net, used to facilitate payment of the subscription.

Responses

201

Success. The subscriber is created.

application/json

Schema

Schema

data Subscriber

id UUID (string)

The unique identifier.

type SubscriptionSubscriberType (string)required

Possible values: [subscription_subscriber]

attributes SubscriberAttributesrequired

account_id UUID (string)required

The unique identifier.

name stringrequired

Possible values: >= 3 characters and <= 1024 characters

The name of the subscriber.

email emailrequired

Possible values: >= 3 characters and <= 1024 characters

The email of the subscriber.

payment_authority object

oneOf

PaymentAuthorityStripe

type stringrequired

Possible values: [elastic_path_payments_stripe]

The name of the payment gateway facilitating the secure transmission of payment data.

customer_id string

Possible values: >= 3 characters and <= 1024 characters

The unique identifier for a customer.

card_id string

Possible values: >= 3 characters and <= 1024 characters

The unique identifier of the card used to facilitate payment of the subscription. If a card payment fails, you can use the card_id and customer_id attributes to program your front-end implementation to allow your preferred payment service provider to update a subscription with new card details. See Card declines.

PaymentAuthorityAuthorizeNet

type stringrequired

Possible values: [authorize_net]

The name of the payment gateway facilitating the secure transmission of payment data.

payment_profile_id string

Possible values: >= 3 characters and <= 1024 characters

The customer's payment profile id, unique to Authorize.net, used to facilitate payment of the subscription.

customer_profile_id string

Possible values: >= 3 characters and <= 1024 characters

The customer's profile id, unique to Authorize.net, used to facilitate payment of the subscription.

updated_at stringrequired

The date and time a resource was updated.

created_at stringrequired

The date and time a resource was created.

meta SubscriberMetarequired

owner stringrequired

The owner of a resource, either store or organization.

timestamps Timestampsrequired

updated_at stringrequired

The date and time a resource was updated.

created_at stringrequired

The date and time a resource was created.

Example (from schema)

{
  "data": {
    "id": "11111111-2222-3333-4444-555555555555",
    "type": "subscription_subscriber",
    "attributes": {
      "account_id": "11111111-2222-3333-4444-555555555555",
      "name": "John Doe",
      "email": "john.doe@example.com",
      "payment_authority": {
        "type": "elastic_path_payments_stripe",
        "customer_id": "cus_OPfKlxWV3hp9h6",
        "card_id": "card_8Diw3FQPhxK27WADPVMeXieP"
      },
      "updated_at": "2017-01-10T11:41:19.244842Z",
      "created_at": "2017-01-10T11:41:19.244842Z"
    },
    "meta": {
      "owner": "store",
      "timestamps": {
        "updated_at": "2017-01-10T11:41:19.244842Z",
        "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"
    }
  ]
}

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"
    }
  ]
}

Loading...