Get subscription plan

GET https://api.ecurring.com/subscription-plans/{id}

Retrieve a single subscription plan by its identifier.

Parameters

Replace {id} in the URL with the identifier of the plan.

include
string
Optional - A comma seperated list of relationships to include in the response. Possible values: subscriptions
fields[TYPE]
string
Optional - A comma seperated list of fields to return as data properties in the response. Known as Sparse Fieldsets. Replace TYPE with the name of the resource.

Response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

Data attributes

name
string
The administrative name of the subscription plan
description
string
The description of the subscription plan as shown to your customers
start_date
datetime
The start date of the subscription plan. If this date is in the future, no transactions will be scheduled until this date is reached. You can, however, already add subscriptions to the plan before it starts. In ISO 8601 format.
status
string
The current status of the subscription plan. Possible values: active / inactive
mandate_authentication_method
string
The method used for authenticating the mandate of new subscribers. Possible values: email / sms / ideal / online_payment / first_payment.
NOTE: the ideal method has been deprecated and replaced by the online_payment method.
send_invoice
boolean
Whether the invoices for the transactions should be sent to the customers by email. Invoices are sent 2 days before the expected collection date.
storno_retries
integer
The amount of times a transaction should be retried after a chargeback. For example, a storno_retries count of 2 could result in a total of 3 collection attempts.
terms
string
Optional - The URL to the terms of service attached to the subscription plan
created_at
datetime
The date on which the subscription plan was created
updated_at
datetime
The date on which the subscription plan was last updated

Relationships

subscriptions
subscription
The subscriptions attached to the plan

Example

{
  "links": {
    "self": "https://api.ecurring.com/subscription-plans/1"
  },
  "data": {
    "type": "subscription-plan",
    "id": "1",
    "links": {
      "self": "https://api.ecurring.com/subscription-plans/1"
    },
    "attributes": {
      "name": "One Size Fits All",
      "description": "eCurring - One Size Fits All",
      "start_date": "2017-01-01T00:00:00+02:00",
      "status": "active",
      "mandate_authentication_method": "online_payment",
      "send_invoice": true,
      "storno_retries": 1,
      "terms": null
    },
    "relationships": {
      "subscriptions": {
        "links": {
          "related": "https://api.ecurring.com/subscription-plans/1/subscriptions"
        },
        "data": [
          {
            "type": "subscription",
            "id": "2862"
          },
          { ... }
        ]
      }
    }
  }
}