The subscription object

Subscriptions are created automatically by Evy once an order is placed.

Example subscription object

JSON

{
  "object": "subscription",
  "id": "d6c50974-70c7-49f8-b50c-797bcefbdeb1",
  "external_id": "subscription-1",
  "start_date": "2024-03-01",
  "store_id": "d41aaaf9-4cbb-4025-b128-da19396cf1dd",
  "payment_handler": "merchant",
  "customer_email": "[email protected]",
  "created_at": "2024-03-01T17:28:33.689374Z",
  "items": [
    {
      "object": "subscription_item",
      "id": "390422c2-8f13-4b77-b44f-824c159051da",
      "amount": 990,
      "created_at": "2024-03-12T14:50:22.459526Z",
      "currency": "EUR",
      "order_external_id": "order-6252",
      "recurring_interval": "month",
      "store_id": "d41aaaf9-4cbb-4025-b128-da19396cf1dd",
      "subscription_id": "d6c50974-70c7-49f8-b50c-797bcefbdeb1"
   }
  ]
}

Attributes

object	string, value is subscription	String representing the object’s type. Objects of the same type share the same value.
id	string, uuid	Unique identifier of the subscription.
start_date	date	Date when the subscription was first created. The date might differ from the created date due to backdating. Formatted as a ISO 8601 date (ex: "2023-04-23").
items	list	List of subscription items each with an attached price.
external_id	string	The external identifier of the subscription specified by the merchant upon creation.
store_id	string, uuid	The unique identifier of the store this subscription belongs to.
payment_handler	enum, possible values are merchant, evy	Who handles the payment of the subscription. The value will be merchant if the order is created directly and evy if order was placed via the Evy checkout app.
customer_email	string	The email of the customer associated with this subscription.
created_at	timestamp	Time at which the subscription object was created. Formatted as a RFC 3339 timestamp.