The subscription item object

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

Example subscription object

{
  "object": "subscription_item",
  "id": "390422c2-8f12-4b77-b44f-824c159051da",
  "amount": 990,
  "contract_id": null,
  "created_at": "2024-03-12T14:50:22.459526Z",
  "currency": "EUR",            
  "order_external_id": "order-6262",
  "recurring_interval": "month",
  "store_id": "d2ec7944-2c8e-420a-893d-389bda1caf22",
  "subscription_id": "f1911eb2-e3ac-3a1e-bff3-e4bdc1af2b4c"
}

Attributes

object

string, value is subscription_item

String representing the object’s type. Objects of the same type share the same value.

id

string, uuid

Unique identifier of the subscription object.

amount

int64

The price of the subscription item in cents. This is derived from the order offer amount this item is linked to.

currency

string

Three-letter ISO 4217 currency code, in uppercase. Must be a supported currency .

recurring_interval

enum

The frequency at which a subscription is billed. One of 'month' or 'year'.

created_at

timestamp

Time at which the subscription item object was created. Formatted as a RFC 3339 timestamp.

store_id

string, uuid

The unique identifier of the store this subscription item belongs to.

subscription_id

string, uui

The unique identifier of the subscription that this item belongs to.

order_external_id

string

  • *DEPRECATED:** depending on the subscription, this field may be incorrect.
    In order to map a subscription item to a Contract or Order, please use the subscription_id field on Contract or Order.