OBJECT

Subscription

link GraphQL Schema definition

1type Subscription {
2id: Int!
3
4# All elements are always returned
5attentionReasons: [AttentionReason!]!
6
7interval: DateInterval!
8
9needsAttention: Boolean!
10
11# Next day when the order should be created according to schedule and selected interval.
12#
13# Arguments
14# format: (self-explanatory)
15nextOrderDate(format: String = "Y-m-d"): Date
16
17# Next day when the order creation will be attempted. Takes last failures and retrial mechanics into account.
18#
19# Arguments
20# format: (self-explanatory)
21nextRetryDate(format: String = "Y-m-d"): Date
22
23# Number of failed tries to create the order for the last scheduled order date.
24tries: Int!
25
26# In the eventuality that the payment requires a confirmation notification,
27# it shows that it cannot be processed again
28isWaitingForPayment: Boolean!
29
30# Required permission: Subscription.internalComment:read
31internalComment: String
32
33discount: Float
34
35# Arguments
36# format: ISO-8601
37createdAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz!
38
39# Arguments
40# format: ISO-8601
41updatedAt(format: String = "Y-m-d\\TH:i:sP"): DateTimeTz!
42
43# Required permission: Subscription:read
44#
45# Store restrictions apply.
46contract: SubscriptionContract!
47
48# Recurring orders generated accordingly to subscription schedule.
49#
50# Required permission: Order:read
51#
52# Limit must be in range 1 - 200
53#
54# Store restrictions apply.
55#
56# Arguments
57# where: (self-explanatory)
58# sort: (self-explanatory)
59# limit: (self-explanatory)
60# page: (self-explanatory)
61generatedOrders(where: OrderFilter, sort: [OrderSort!] = [orderDate_DESC], limit: Int = 20, page: Int = 1): [Order!]!
62
63# Required permission: Subscription:read
64#
65# All elements are always returned
66lines: [SubscriptionLine!]!
67
68# Required permission: SubscriptionPlan:read
69#
70# Store restrictions apply.
71plan: SubscriptionPlan
72
73status: SubscriptionStatus!
74
75}